REST API Documentation - CAFE24 REST API

Code	발생하는 사례	오류 해결 방법
200	GET 성공, PUT 성공, DELETE 성공시
201	POST 성공시
207	다중 요청 등록시 상태가 객체별로 다른 경우	오류 상태를 객체별로 확인하여 해당 상태에 따라 대응합니다.
400	서버에서 요청을 이해할 수 없음 1) Content-Type이 잘못 지정되어있음 2) application/type이 json이 아님	요청시 "Content-Type"이 application/json으로 되어있는지 확인합니다.
400	요청 API URL에 한글 또는 특수문자를 인코딩하지 않고 그대로 사용한 경우	요청 API URL에 한글 또는 특수문자를 URL 인코딩하였는지 확인합니다.
401	1) Access Token 없이 호출한 경우 2) Access Token이 유효하지 않은 경우 3) Access Token이 만료된 경우 4) 알 수 없는 클라이언트일 경우	유효한 발급 절차에 따라 발급받은 Access Token을 사용하였는지 확인합니다.
401	Front API 사용시 client_id를 미입력한 경우	유효한 클라이언트 ID를 사용하였는지 확인합니다.
403	1) Access Token은 있으나 해당 Scope에 권한이 없음 2) Front API에서 볼 수 있는 권한이 없을 경우	API를 호출할 수 있는 권한이 있는지 API의 Scope 또는 쇼핑몰의 설정을 확인합니다.
403	https 프로토콜이 아닌 경우	API 요청시 https 로 요청하였는지 확인합니다.
403	뉴상품 쇼핑몰이 아닌 경우	쇼핑몰이 (뉴)상품관리로 업그레이드 되어야 사용 가능합니다.
403	(Admin API 호출시) 쇼핑몰에서 해당 앱이 삭제된 경우	쇼핑몰에 앱이 설치되었는지 확인 후 앱을 다시 설치합니다.
403	(Front API 호출시) 쇼핑몰에서 해당 앱이 삭제된 경우	쇼핑몰에 앱이 설치되었는지 확인 후 앱을 다시 설치합니다.
404	1) API URL을 잘못 호출한 경우 2) 리소스를 찾을 수 없을 경우 3) {#id}가 없는 경우	엔드포인트 URL의 오류가 있는지 API 문서를 참고하여 확인합니다.
409	동일 리소스에 동일 내용을 업데이트할 경우	수정할 데이터를 요청해주세요.
422	조회/처리 요청시 값이 정해진 스펙과 다를 경우 1) 필수 파라메터 누락함 2) 정해진 스펙과 다를 경우	API 문서를 참고하여 필수 파라메터가 입력되지 않았거나 유효하지 않은 값을 입력하였는지 확인합니다.
429	클라이언트의 API 요청이 Bucket을 초과한 경우	API 최대 허용 요청 건수를 초과하지 않도록 잠시 후 다시 요청합니다.
500	내부 서버 에러, 알 수 없는 에러	일시적으로 에러가 발생하였습니다. 잠시 후에 다시 시도합니다.
503	현재 서버가 다운된 경우	개발자센터로 문의해주세요.
503	서버가 다운된 경우. API를 사용할 수 없음.	개발자센터로 문의해주세요.
504	요청 시간이 초과된 경우(Timeout)	일시적으로 에러가 발생하여 응답이 지연되고 있습니다. 잠시 후에 다시 시도해주세요.

Activitylogs

활동로그(Activitylog)는 쇼핑몰 관리자가 쇼핑몰 어드민에서 진행한 운영 활동을 기록한 내역입니다.
활동로그 리소스를 사용하면 쇼핑몰의 활동로그를 생성하거나 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/activitylogs
GET /api/v2/admin/activitylogs/{process_no}

Activitylogs properties

Attribute	Description
process_no	업무처리 넘버
mode	모드 P : PC 어드민 M : 모바일 어드민 S : (구)스마트모드
type	구분
content	업무내용
process_date	처리일시
manager_id 형식 : [a-z0-9] 글자수 최소: [4자]~최대: [16자]	처리자
manager_type	처리자 타입

Retrieve a list of action logs

GET /api/v2/admin/activitylogs

GET

활동로그를 목록으로 조회할 수 있습니다.
운영 활동을 한 사람이 누구인지, 어떤 메뉴에서 언제 진행했는지 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter	Description
manager_type	처리자 타입 P : 대표운영자 A : 부운영자 S : 공급사
manager_id 형식 : [a-z0-9] 글자수 최소: [4자]~최대: [16자]	처리자
mode	모드 P : PC 어드민 M : 모바일 어드민 S : (구)스마트모드
type	구분
content 최대글자수 : [500자]	업무내용
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Retrieve an action log

GET /api/v2/admin/activitylogs/{process_no}

GET

활동로그를 상세 조회할 수 있습니다.
운영 활동을 한 사람이 누구인지, 어떤 메뉴에서 언제 진행했는지 확인할 수 있으며, content를 통해 진행한 내역을 상세하게 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter	Description
process_no Required	업무처리 넘버

Request Copy

Response Copy

Automessages arguments

자동메시지 변수(Automessages arguments)는 자동메시지 발신 시 사용할 수 있는 변수를 확인하는 리소스입니다.

Endpoints

GET /api/v2/admin/automessages/arguments

Automessages arguments properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
name	변수명
description	변수 설명
sample	변수 예제
string_length	메시지 표시 최대 글자수 글자수 : 설정된 글자수 만큼 표시 가변 : 글자수 제한 없이 모두 표시
send_case	사용 가능 발송 상황

Retrieve the list of available variables for automated messages

GET /api/v2/admin/automessages/arguments

GET

자동메시지 발송 설정내역을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Automessages setting

자동메시지 설정(Automessages setting)은 메시지 자동 발송 시 사용 중인 발송 수단을 확인 및 어떤 발송 수단으로 우선발송할 지 조회, 변경하는 리소스입니다.

Endpoints

GET /api/v2/admin/automessages/setting
PUT /api/v2/admin/automessages/setting

Automessages setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
use_sms	SMS 사용 여부 T: 사용함 F: 사용안함
use_kakaoalimtalk	카카오알림톡 사용 여부 T: 사용함 F: 사용안함
use_push	PUSH 사용 여부 T: 사용함 F: 사용안함
send_method	자동 발송 메시지 발송 방법 S: SMS K: 카카오알림톡(발송 실패 시 SMS로 대체 발송)
send_method_push	푸시 수신 대상에게 푸시 우선 발송 여부 T : 우선 발송함 F : 우선 발송 안함

Retrieve the automated message settings

GET /api/v2/admin/automessages/setting

GET

자동메시지 발송 설정내역을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update an automated message

PUT /api/v2/admin/automessages/setting

PUT

자동메시지 발송 설정내역을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

send_method
Required

자동 발송 메시지 발송 방법

S: SMS
K: 카카오알림톡(발송 실패 시
SMS로 대체 발송)

send_method_push

푸시 수신 대상에게 푸시 우선 발송 여부

T : 우선 발송함
F : 우선 발송 안함

Request Copy

Response Copy

Coupons setting

쿠폰 설정(Coupons setting)은 쇼핑몰에서 사용할 쿠폰의 기본적인 설정을 입력할 수 있습니다.
쿠폰의 할인, 적립 기능의 사용여부와 제한조건, 진열 등 다양한 측면의 설정이 가능합니다.

Endpoints

GET /api/v2/admin/coupons/setting
PUT /api/v2/admin/coupons/setting

Coupons setting properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
use_coupon	쿠폰사용 T:사용함 F:사용안함
available_issue_type	쿠폰 사용 제한 A:주문서+상품별 쿠폰 사용 O:주문서 쿠폰만 사용 P:상품별 쿠폰만 사용
allow_using_coupons_with_points	적립금 동시사용 T:사용함 F:사용안함
allow_using_coupons_with_discounts	할인 동시사용 A:쿠폰+회원등급 할인 동시 사용 C:쿠폰만 사용 G:회원등급 할인만 사용
allow_using_product_and_order_coupons	상품/주문서 동시사용 T:사용함 F:사용안함
recover_coupon_setting	쿠폰 복원 설정
max_coupon_count	쿠폰 사용 개수 제한
use_additional_coupon	추가 사용 쿠폰 T:사용함 F:사용안함
additional_coupon_no	추가 사용 쿠폰 번호
show_coupon_to_non_members	비회원 노출설정 T:노출함 F:노출안함
show_group_coupon_to_non_members	회원등급할인이 지정된 쿠폰 포함 T : 포함 F : 미포함
show_issued_coupon	발급된 쿠폰 표시 여부 T:노출함 F:노출안함
sorting_type	정렬 기준 A:쿠폰 시작일자 B:쿠폰 종료일자 C:쿠폰 발급일자 D:할인/적립금액 E:할인/적립율
download_image_type	기본 쿠폰 다운로드 이미지 1:TYPE1 2:TYPE2 3:TYPE3 4:TYPE4 5:TYPE5
background_image_type	기본 쿠폰 배경 이미지 1:TYPE1 2:TYPE2 3:TYPE3 4:TYPE4 5:TYPE5

Retrieve coupon settings

GET /api/v2/admin/coupons/setting

GET

쿠폰 사용 여부나 쿠폰과 할인 동시 사용 여부 등 설정 정보를 조회합니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update coupon settings

PUT /api/v2/admin/coupons/setting

PUT

쿠폰 설정 정보를 수정합니다.
쿠폰 사용여부, 쿠폰 사용 제한, 쿠폰 사용 개수 제한 등의 정보를 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
use_coupon	쿠폰사용 T:사용함 F:사용안함
available_issue_type	쿠폰 사용 제한 A:주문서+상품별 쿠폰 사용 O:주문서 쿠폰만 사용 P:상품별 쿠폰만 사용
allow_using_coupons_with_points	적립금 동시사용 T:사용함 F:사용안함
allow_using_coupons_with_discounts	할인 동시사용 A:쿠폰+회원등급 할인 동시 사용 C:쿠폰만 사용 G:회원등급 할인만 사용
allow_using_product_and_order_coupons	상품/주문서 동시사용 T:사용함 F:사용안함
recover_coupon_setting	쿠폰 복원 설정
restore_viewpoint 쿠폰 복원 시점 A: 취소/교환/반품 접수 B: 취소/교환/반품 완료 cancel_before_pay 입금전취소 T:자동 복원함 F:자동 복원 안함 M:쿠폰복원 여부를 확인함 cancel_after_pay 입금후 취소 T:자동 복원함 F:자동 복원 안함 M:쿠폰복원 여부를 확인함 return 반품 T:자동 복원함 F:자동 복원 안함 M:쿠폰복원 여부를 확인함 exchange 교환 T:자동 복원함 F:자동 복원 안함 M:쿠폰복원 여부를 확인함 part 부분 취소/반품/교환 F:쿠폰 복원 안함 M:쿠폰복원 여부를 확인함
max_coupon_count	쿠폰 사용 개수 제한
product_per_product 상품당 상품쿠폰 사용 개수 제한 order_per_order 1회 주문당 주문서 쿠폰 개수 제한 product_and_order_per_order 주문건당 (주문서+상품쿠폰) 쿠폰 개수 제한 product_per_order 1회 주문당 상품쿠폰 쿠폰 개수 제한 product_and_order_per_day 일간 (주문서+상품쿠폰) 쿠폰 개수 제한
use_additional_coupon	추가 사용 쿠폰 T:사용함 F:사용안함
additional_coupon_no 배열 최대사이즈: [5]	추가 사용 쿠폰 번호
coupon_no 쿠폰번호
show_coupon_to_non_members	비회원 노출설정 T:노출함 F:노출안함
show_group_coupon_to_non_members	회원등급할인이 지정된 쿠폰 포함 T : 포함 F : 미포함
show_issued_coupon	발급된 쿠폰 표시 여부 T:노출함 F:노출안함
sorting_type	정렬 기준 A:쿠폰 시작일자 B:쿠폰 종료일자 C:쿠폰 발급일자 D:할인/적립금액 E:할인/적립율
download_image_type	기본 쿠폰 다운로드 이미지 1:TYPE1 2:TYPE2 3:TYPE3 4:TYPE4 5:TYPE5
background_image_type	기본 쿠폰 배경 이미지 1:TYPE1 2:TYPE2 3:TYPE3 4:TYPE4 5:TYPE5

Request Copy

Response Copy

Currency

환율 정보(Currency)는 쇼핑몰의 화폐 정보, 환율 정보 등을 확인할 수 있는 리소스입니다.

Endpoints

GET /api/v2/admin/currency

Currency properties

Attribute	Description
exchange_rate	결제 화폐 환율 정보
standard_currency_code	기준 화폐 코드 해당 쇼핑몰의 기본쇼핑몰에서 사용하는 화폐 코드. 기준 화폐란 일반적으로 쇼핑몰 운영자가 속한 국가에서 통용되는 화폐를 의미한다.
standard_currency_symbol	기준 화폐 심볼 해당 쇼핑몰의 기본쇼핑몰에서 사용하는 화폐의 화폐 기호. 기준 화폐란 일반적으로 쇼핑몰 운영자가 속한 국가에서 통용되는 화폐를 의미한다.
shop_currency_code	결제 화폐 코드
shop_currency_symbol	결제 화폐 심볼
shop_currency_format	결제 화폐 표시 방식

Retrieve currency settings

GET /api/v2/admin/currency

GET

쇼핑몰에서 사용하는 화폐의 정보와 환율 정보를 조회합니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

Request Copy

Response Copy

Dashboard

대시보드(Dashboard)는 쇼핑몰의 주문 현황과 매출 현황 등 쇼핑몰 운영에 필요한 정보를 간략하게 요약해놓은 정보입니다.

Endpoints

GET /api/v2/admin/dashboard

Dashboard properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
daily_sales_stats	일일 현황 정보 일 단위의 매출 현황 정보
weekly_sales_stats	주간 매출 현황 주간 단위의 매출 현황 정보
monthly_sales_stats	월간 매출 현황 월간 단위의 매출 현황 정보
sold_out_products_count	품절된 상품 수 품절된 상품의 수. 재고관리기능과 품절기능이 활성화 되어있을 경우 집계에 포함됨.
new_members_count	신규회원 수 신규가입한 회원의 숫자
board_list	게시판 목록 해당 몰의 게시판의 리스트

Retrieve a dashboard

GET /api/v2/admin/dashboard

GET

대시보드 정보를 조회합니다.
매출 현황 정보등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

Request Copy

Response Copy

Financials paymentgateway

Financials paymentgateway(PG 정보)는 PG사별 계약정보를 제공합니다.

Endpoints

GET /api/v2/admin/financials/paymentgateway

Financials paymentgateway properties

Attribute	Description
partner_id	PG사 발급 가맹점 ID
payment_gateway_name	PG 이름 inicis : 이니시스 kcp : KCP allat : 올앳 ksnet : KSNET dacom : 토스페이먼츠 allthegate : 올더게이트 settlebank : 세틀뱅크 smartro : 스마트로 kicc : 한국정보통신 mobilians : 모빌리언스 danal : 다날
contract_date	PG 계약일
setting_date	PG 세팅일
bank_code	정산입금 은행코드 은행 코드 조회하기
bank_account_no	정산입금 계좌정보
status	금융제휴여부 T:제휴함 F: 제휴안함
bank_account_name	정산입금 예금주명
payment_method_information	결제수단별 정산 정보 ※ payment_method_information 하위 요소에 대한 값 정의 1) payment_method_information > period(정산 기간) D : 일별 W : 주별 M : 월별

Retrieve a list of Payment Gateway contract details

GET /api/v2/admin/financials/paymentgateway

GET

PG사별 계약정보를 목록으로 조회할 수 있습니다.
PG계약일, 결제수단별 정산 정보 등을 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter	Description
payment_gateway_name	PG 이름
partner_id	PG사 발급 가맹점 ID

Request Copy

Response Copy

Financials store

Financials store(상점의 거래정보)는 상점의 PG사별 거래정보를 제공합니다.

Endpoints

GET /api/v2/admin/financials/store

Financials store properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
first_payment_date	최초 결제일
payment_gateway_name	PG 이름

Retrieve the transaction information of a store

GET /api/v2/admin/financials/store

GET

상점의 결제수단별 거래정보를 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

payment_method
Required

결제수단 코드

card : 신용카드
tcash : 계좌이체
icash : 가상계좌
cell : 휴대폰
deferpay : 후불
cvs : 편의점
point : 선불금
etc : 기타

Request Copy

Response Copy

Images setting

상품 이미지 사이즈 설정 값을 조회하거나 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/images/setting
PUT /api/v2/admin/images/setting

Images setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
product_image_size	상품 이미지 사이즈 설정값

Retrieve product image size settings

GET /api/v2/admin/images/setting

GET

상품 이미지 사이즈 설정 값을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update product image size settings

PUT /api/v2/admin/images/setting

PUT

상품 이미지 사이즈 설정 값을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

product_image_size
Required

상품 이미지 사이즈 설정값

detail_image_width
상세 이미지 가로

detail_image_height
상세이미지 세로

list_image_width
목록 이미지 가로

list_image_height
목록 이미지 세로

tiny_image_width
작은 목록 이미지 가로

tiny_image_height
작은 목록 이미지 세로

zoom_image_width
확대 이미지 가로

zoom_image_height
확대 이미지 세로

small_image_width
축소 이미지 가로

small_image_height
축소 이미지 세로

Request Copy

Response Copy

Kakaoalimtalk profile

상점의 카카오채널 프로필키 등록여부를 확인할 수 있는 리소스입니다.

Endpoints

GET /api/v2/admin/kakaoalimtalk/profile

Kakaoalimtalk profile properties

Attribute

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

kakao_senderkey

카카오 채널 발신 프로필 키

Retrieve a Kakao Channel sender profile key

GET /api/v2/admin/kakaoalimtalk/profile

GET

카카오채널 발신 프로필키(senderkey)를 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Kakaoalimtalk setting

카카오알림톡 서비스(Kakaoalimtalk setting) 사용 여부를 조회하고 설정을 변경하는 리소스입니다.

Endpoints

GET /api/v2/admin/kakaoalimtalk/setting
PUT /api/v2/admin/kakaoalimtalk/setting

Kakaoalimtalk setting properties

Attribute

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

use_kakaoalimtalk

카카오알림톡 사용 여부

T: 사용함
F: 사용안함

Retrieve the Kakao Info-Talk settings

GET /api/v2/admin/kakaoalimtalk/setting

GET

카카오알림톡 서비스 발송설정 내역을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update the Kakao Info-Talk settings

PUT /api/v2/admin/kakaoalimtalk/setting

PUT

카카오알림톡 서비스 발송 설정내역을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

use_kakaoalimtalk

카카오알림톡 사용 여부

T: 사용함
F: 사용안함

Request Copy

Response Copy

Kakaopay setting

쇼핑몰의 카카오페이 설정을 조회하거나 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/kakaopay/setting
PUT /api/v2/admin/kakaopay/setting

Kakaopay setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
shop_key	입점시 부여 받는 판매점의 고유 식별자
pixel_code	연동사(ECP/독립몰)에서 이미 사용중인 카카오 광고 픽셀 ID
use_kakaopay	카카오페이 구매 사용여부 T : 사용함 F : 사용안함
product_detail_button_size	쇼핑몰 상세상품 페이지 버튼 사이즈
basket_button_size	쇼핑몰 장바구니 페이지 버튼 사이즈
use_dark_mode	쇼핑몰 다크모드 적용여부 T : 활성화 F : 비활성화
button_authorization_key	입점시 부여 받는 판매점의 버튼 인증
thirdparty_agree	제3자 제공 동의 여부 T : 동의함 F : 동의안함
thirdparty_agree_date	제3자 제공 동의 날짜

Retrieve settings for KakaoPay orders

GET /api/v2/admin/kakaopay/setting

GET

쇼핑몰의 카카오페이 설정을 조회합니다.
카카오페이 구매 사용여부, 제3자 제공 동의 여부 등의 정보를 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update settings for KakaoPay orders

PUT /api/v2/admin/kakaopay/setting

PUT

쇼핑몰의 카카오페이 설정을 수정합니다.
카카오페이 구매 사용여부, 쇼핑몰 다크모드 적용여부 등의 정보를 수정할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
shop_key	입점시 부여 받는 판매점의 고유 식별자
pixel_code	연동사(ECP/독립몰)에서 이미 사용중인 카카오 광고 픽셀 ID
use_kakaopay	카카오페이 구매 사용여부 T : 사용함 F : 사용안함
product_detail_button_size	쇼핑몰 상세상품 페이지 버튼 사이즈
pc pc mobile mobile
basket_button_size	쇼핑몰 장바구니 페이지 버튼 사이즈
pc pc mobile mobile
use_dark_mode	쇼핑몰 다크모드 적용여부 T : 활성화 F : 비활성화
button_authorization_key	입점시 부여 받는 판매점의 버튼 인증
thirdparty_agree	제3자 제공 동의 여부 T : 동의함 F : 동의안함
thirdparty_agree_date 날짜	제3자 제공 동의 날짜

Request Copy

Response Copy

Menus

메뉴(Menus)는 쇼핑몰의 메뉴 모드에 관한 기능입니다.
쇼핑몰의 메뉴 모드와 경로 등을 조회할 수 있습니다.
쇼핑몰의 메뉴 모드로는 프로모드, 스마트모드, 모바일 어드민이 있습니다.

Endpoints

GET /api/v2/admin/menus

Menus properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
mode	메뉴 모드 new_pro: PC 어드민 mobile_admin : 모바일 어드민
menu_no	메뉴 번호
name	메뉴명
path	메뉴 경로
contains_app_url	앱 URL 포함 여부 T : 포함 F : 미포함

Retrieve menus

GET /api/v2/admin/menus

GET

쇼핑몰의 메뉴 모드와 경로 등을 목록으로 조회할 수 있습니다.
메뉴 모드, 메뉴 번호, 앱 URL 포함 여부 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
mode	메뉴 모드 new_pro: PC 어드민 mobile_admin : 모바일 어드민 DEFAULT new_pro
menu_no	메뉴 번호 ,(콤마)로 여러 건을 검색할 수 있다.
contains_app_url	앱 URL 포함 여부 T : 포함 F : 미포함

Request Copy

Response Copy

Mobile setting

모바일 설정(Mobile setting)은 쇼핑몰의 모바일 쇼핑몰 설정에 관한 리소스입니다.
모바일 쇼핑몰 사용 여부와 접속 주소 자동연결의 사용/사용안함 여부를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/mobile/setting

Mobile setting properties

Attribute

Description

shop_no

멀티쇼핑몰 번호

use_mobile_page

모바일 쇼핑몰 사용설정

T : 사용함
F : 사용안함

use_mobile_domain_redirection

모바일 접속 주소 자동연결 설정

T : 사용함
F : 사용안함

Retrieve mobile settings

GET /api/v2/admin/mobile/setting

GET

쇼핑몰의 모바일 설정을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	10

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Naverpay setting

네이버페이 설정(Naverpay Setting)은 쇼핑몰의 네이버페이 공통인증키를 조회하거나 수정할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/naverpay/setting
POST /api/v2/admin/naverpay/setting
PUT /api/v2/admin/naverpay/setting

Naverpay setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
authentication_key	네이버 공통 인증키
naverpay_version	네이버페이 연동버전
shop_id	페이센터 ID
is_button_show	네이버페이 구매 버튼 노출
is_used_order	네이버 주문연동
is_used_review	네이버 구매평연동
is_show_review	네이버 구매평노출
is_order_page	네이버페이 구매 버튼 클릭 시 페이지 이동
certi_key	네이버 가맹점 인증키
image_key	네이버 버튼 인증키
naver_button_pc_product	네이버 버튼 디자인 : PC 상품상세페이지
naver_button_pc_basket	네이버 버튼 디자인 : PC 장바구니페이지
naver_button_mobile_product	네이버 버튼 디자인 : Mobile 상품상세페이지
naver_button_mobile_basket	네이버 버튼 디자인 : Mobile 장바구니페이지

Retrieve Naver Pay settings

GET /api/v2/admin/naverpay/setting

GET

쇼핑몰의 네이버페이 공통인증키를 조회합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Create Naver Pay settings

POST /api/v2/admin/naverpay/setting

POST

네이버페이 가맹 시 네이버에서 발급한 공통인증키를 쇼핑몰 어드민에 등록할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
authentication_key 형식 : [a-zA-Z0-9_-] 최대글자수 : [50자]	네이버 공통 인증키
naverpay_version	네이버페이 연동버전 DEFAULT 2.1
shop_id Required	페이센터 ID
is_button_show	네이버페이 구매 버튼 노출 DEFAULT T
is_used_order	네이버 주문연동 DEFAULT T
is_used_review	네이버 구매평연동 DEFAULT T
is_show_review	네이버 구매평노출 DEFAULT T
is_order_page	네이버페이 구매 버튼 클릭 시 페이지 이동 DEFAULT N
certi_key Required	네이버 가맹점 인증키
image_key Required	네이버 버튼 인증키
naver_button_pc_product	네이버 버튼 디자인 : PC 상품상세페이지 DEFAULT A\|1\|2
naver_button_pc_basket	네이버 버튼 디자인 : PC 장바구니페이지 DEFAULT A\|1\|1
naver_button_mobile_product	네이버 버튼 디자인 : Mobile 상품상세페이지 DEFAULT MA\|1\|2
naver_button_mobile_basket	네이버 버튼 디자인 : Mobile 장바구니페이지 DEFAULT MA\|1\|1

Request Copy

Response Copy

Update Naver Pay settings

PUT /api/v2/admin/naverpay/setting

PUT

쇼핑몰의 네이버페이 공통인증키를 수정합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

authentication_key

형식 : [a-zA-Z0-9_-]
최대글자수 : [50자]

네이버 공통 인증키

Request Copy

Response Copy

Orders setting

취소/반품시 자동 수량 복구 및 할인/적립 금액 등 주문 설정에 대해 조회, 수정 할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/orders/setting
PUT /api/v2/admin/orders/setting

Orders setting properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
claim_request	구매자 취소/교환/반품 신청 사용설정 T : 사용함 F : 사용안함
claim_request_type	구매자 취소/교환/반품 신청 시 표시항목 설정 claim_request 항목이 T일 때만 확인이 가능하다. S : 기본신청 항목 표시 D : 상세신청 항목 표시
claim_request_button_exposure	구매자 취소/교환/반품 신청버튼 노출 범위 설정 cancel_N10 : 취소신청 상품준비중 cancel_N20 : 취소신청 배송준비중 cancel_N22 : 취소신청 배송보류 cancel_N21 : 취소신청 배송대기 exchange_N00 : 교환신청 입금전 exchange_N10 : 교환신청 상품준비중 exchange_N20 : 교환신청 배송준비중 exchange_N22 : 교환신청 배송보류 exchange_N21 : 교환신청 배송대기 exchange_N30 : 교환신청 배송중 exchange_N40 : 교환신청 배송완료 return_N30 : 반품신청 배송중 return_N40 : 반품신청 배송완료
claim_request_button_date_type	구매자 취소/교환/반품 신청버튼 노출 기준일 order_date : 주문 완료일 기준 shipend_date : 배송완료일 기준
claim_request_button_period	구매자 취소/교환/반품 신청버튼 노출 기간
stock_recover	취소/반품 시 자동 수량복구 T : 기본 설정 F : 개별 설정
stock_recover_base	취소/반품 시 자동 수량복구 - 기본설정 T : 자동 복구함 F : 자동 복구 안함 M : 수량복구 여부를 확인함
stock_recover_individual	취소/반품 시 자동 수량복구 - 개별설정
claim_request_auto_accept	구매자 취소/반품 신청 건 자동 접수 설정 T : 사용함 F : 사용안함
refund_benefit_setting	취소/교환/반품 접수 시 할인/적립 금액 설정
refund_processing_setting	취소/교환/반품 접수 시 환불 접수 처리 설정 S : 동시에 처리함 D : 분리하여 처리함
use_product_prepare_status	상품준비중 주문상태 사용여부 T : 사용함 F : 사용안함
use_purchase_confirmation_button	구매확정 버튼 사용여부 T : 사용함 F : 사용안함
purchase_confirmation_button_set_date	구매확정 버튼 적용 날짜
use_purchase_confirmation_auto_check	구매확정 자동체크 사용여부 T : 사용함 F : 사용안함
purchase_confirmation_auto_check_day	구매확정 자동체크 기준일
purchase_confirmation_auto_check_set_date	구매확정 자동체크 적용 날짜
use_additional_fields	추가항목 사용 여부 T : 사용함 F : 사용안함
customer_pays_return_shipping	배송 후 교환/반품 신청 시 구매자부담 배송비 결제 사용 여부 T : 사용함 F : 사용안함
refund_bank_account_required	취소/교환/반품 시 환불계좌정보 등록 필수 여부 T : 필수 F : 선택

Retrieve Order Settings

GET /api/v2/admin/orders/setting

GET

취소/반품시 자동 수량 복구 및 할인/적립 금액 등 주문 설정에 대해 조회합니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update Order settings

PUT /api/v2/admin/orders/setting

PUT

취소/교환/반품 접수 시의 할인/적립 금액 설정을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
refund_benefit_setting	취소/교환/반품 접수 시 할인/적립 금액 설정 F: 전체 금액 기준으로 표시 T: 선택 품목 기준으로 표시 U: 할인금액 자동계산(설정한 이후 접수된 주문부터 적용)
use_product_prepare_status	상품준비중 주문상태 사용여부 T : 사용함 F : 사용안함
use_purchase_confirmation_button	구매확정 버튼 사용여부 T : 사용함 F : 사용안함
purchase_confirmation_button_set_date 날짜	구매확정 버튼 적용 날짜
use_purchase_confirmation_auto_check	구매확정 자동체크 사용여부 T : 사용함 F : 사용안함
purchase_confirmation_auto_check_day 최소: [1]~최대: [30]	구매확정 자동체크 기준일
purchase_confirmation_auto_check_set_date 날짜	구매확정 자동체크 적용 날짜

Request Copy

Response Copy

Orders status

Endpoints

GET /api/v2/admin/orders/status
PUT /api/v2/admin/orders/status

Orders status properties

Attribute	Description
status_name_id	주문상태 표기명 일련번호
status_type	주문상태 유형 P: 결제 및 배송 D: 후불 결제 C: 취소 R: 반품 E: 교환 U: 환불 O: 기타
basic_name	기본 표기 주문상태명
custom_name	사용자 정의 주문상태명
reservation_custom_name	예약주문 사용자 정의 주문상태명

Retrieve order status displayed

GET /api/v2/admin/orders/status

GET

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update order status displayed

PUT /api/v2/admin/orders/status

PUT

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
status_name_id Required	주문상태 표기명 일련번호
custom_name	사용자 정의 주문상태명
reservation_custom_name	예약주문 사용자 정의 주문상태명

Request Copy

Response Copy

Paymentgateway

PG(Paymentgateway)를 통해 PG앱의 조회, 등록, 수정, 삭제가 가능합니다.

Endpoints

POST /api/v2/admin/paymentgateway
PUT /api/v2/admin/paymentgateway/{client_id}
DELETE /api/v2/admin/paymentgateway/{client_id}

Paymentgateway properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
partner_id	PG사 발급 가맹점 ID
client_id	앱 클라이언트 ID
additional_information	추가 정보
membership_fee_type	가입비 분류 PRE : 선불 PAD : 후불 FREE : 무료
service_limit_type	서비스 제한 A : 회원/비회원 제한 없음 M : 회원만 제공

Create a Payment Gateway

POST /api/v2/admin/paymentgateway

POST

쇼핑몰에 새로운 PG를 등록할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
partner_id Required 최대글자수 : [50자]	PG사 발급 가맹점 ID
additional_information 배열 최대사이즈: [5]	추가 정보
key 추가항목 키 value 추가항목 값
membership_fee_type 최대글자수 : [4자]	가입비 분류 PRE : 선불 PAD : 후불 FREE : 무료
service_limit_type 최대글자수 : [1자]	서비스 제한 A : 회원/비회원 제한 없음 M : 회원만 제공 DEFAULT A

Request Copy

Response Copy

Update a Payment Gateway

PUT /api/v2/admin/paymentgateway/{client_id}

PUT

쇼핑몰에 등록된 PG를 수정할 수 있습니다.
PG사 발급 사맹점 ID, 가입비 여부 등을 수정할 수 있습니다.
수정을 위해서는 PG앱의 클라이언트 아이디가 필수입니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
client_id Required 최대글자수 : [50자]	앱 클라이언트 ID
partner_id 최대글자수 : [50자]	PG사 발급 가맹점 ID
additional_information 배열 최대사이즈: [5]	추가 정보
key 추가항목 키 value 추가항목 값
membership_fee_type 최대글자수 : [4자]	가입비 분류 PRE : 선불 PAD : 후불 FREE : 무료
service_limit_type 최대글자수 : [1자]	서비스 제한 A : 회원/비회원 제한 없음 M : 회원만 제공 DEFAULT A

Request Copy

Response Copy

Delete a Payment Gateway

DELETE /api/v2/admin/paymentgateway/{client_id}

DELETE

쇼핑몰에 등록된 PG를 삭제할 수 있습니다.
삭제를 위해서는 PG앱의 클라이언트 아이디가 필수입니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

client_id
Required

최대글자수 : [50자]

앱 클라이언트 ID

Request Copy

Response Copy

Paymentgateway paymentmethods

PG의 결제수단(Paymentgateway paymentmethods)은 쇼핑몰에 등록된 PG의 결제수단에 대한 기능입니다.
특정 PG에서 제공하고 있는 결제수단의 등록, 조회, 수정, 삭제가 가능합니다.

Endpoints

GET /api/v2/admin/paymentgateway/{client_id}/paymentmethods
POST /api/v2/admin/paymentgateway/{client_id}/paymentmethods
PUT /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}
DELETE /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

Paymentgateway paymentmethods properties

Attribute	Description
client_id	앱 클라이언트 ID
payment_method_code	결제수단 코드
payment_method	결제수단 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 cell : 휴대폰 cvs : 편의점 deferpay : 후불결제 etc : 기타
payment_method_name	결제수단명
payment_method_url	결제수단 이미지 경로
available_shop_no	이용가능한 멀티쇼핑몰 번호

Retrieve a list of Payment Gateway methods

GET /api/v2/admin/paymentgateway/{client_id}/paymentmethods

GET

앱으로 설치한 쇼핑몰의 PG에 대해서 지원하는 결제수단을 조회할 수 있습니다.
결제수단 코드, 결제수단, 결제수단명 등을 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter	Description
client_id Required 최대글자수 : [50자]	앱 클라이언트 ID

Request Copy

Response Copy

Create a Payment Gateway method

POST /api/v2/admin/paymentgateway/{client_id}/paymentmethods

POST

앱으로 설치한 쇼핑몰의 PG에 대해서 결제수단을 등록할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
client_id Required 최대글자수 : [50자]	앱 클라이언트 ID
payment_method_code Required 최대글자수 : [50자]	결제수단 코드
payment_method Required	결제수단 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 cell : 휴대폰 cvs : 편의점 deferpay : 후불결제 etc : 기타
payment_method_name Required 최대글자수 : [50자]	결제수단명
payment_method_url Required 최대글자수 : [200자]	결제수단 이미지 경로 지원 확장자 : 'png', 'jpg', 'jpeg'
available_shop_no	이용가능한 멀티쇼핑몰 번호

Request Copy

Response Copy

Update a payment method of a Payment Gateway

PUT /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

PUT

앱으로 설치한 쇼핑몰의 PG에 대해서 특정 결제수단을 수정할 수 있습니다.
결제수단, 결제수단명 등을 수정할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
client_id Required 최대글자수 : [50자]	앱 클라이언트 ID
payment_method_code Required 최대글자수 : [50자]	결제수단 코드
payment_method	결제수단 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 cell : 휴대폰 cvs : 편의점 deferpay : 후불결제 etc : 기타
payment_method_name 최대글자수 : [50자]	결제수단명
payment_method_url 최대글자수 : [200자]	결제수단 이미지 경로 지원 확장자 : 'png', 'jpg', 'jpeg'
available_shop_no	이용가능한 멀티쇼핑몰 번호

Request Copy

Response Copy

Delete a payment method of a Payment Gateway

DELETE /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

DELETE

앱으로 설치한 쇼핑몰의 PG에 대해서 특정 결제수단을 삭제할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40

요청사양

Parameter	Description
client_id Required 최대글자수 : [50자]	앱 클라이언트 ID
payment_method_code Required 최대글자수 : [50자]	결제수단 코드

Request Copy

Response Copy

Paymentmethods

쇼핑몰에 설정된 결제수단을 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/paymentmethods

Paymentmethods properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
code	결제수단 코드

Retrieve a list of payment methods

GET /api/v2/admin/paymentmethods

GET

쇼핑몰에 설정된 결제수단 목록을 조회합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Paymentmethods paymentproviders

쇼핑몰에 설정된 결제수단의 정보를 조회하거나 결제수단의 노출여부를 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/paymentmethods/{code}/paymentproviders
PUT /api/v2/admin/paymentmethods/{code}/paymentproviders/{name}

Paymentmethods paymentproviders properties

Attribute

Description

shop_no

멀티쇼핑몰 번호

name

PG 이름

display

결제수단 노출여부

T : 노출함
F : 노출안함

Retrieve a list of providers by payment method

GET /api/v2/admin/paymentmethods/{code}/paymentproviders

GET

쇼핑몰에 설정된 결제수단의 정보를 조회합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
code Required	결제수단 코드
name	PG 이름
display	결제수단 노출여부 T : 노출함 F : 노출안함

Request Copy

Response Copy

Update the display status of a payment method

PUT /api/v2/admin/paymentmethods/{code}/paymentproviders/{name}

PUT

쇼핑몰에 설정된 결제수단의 노출여부를 수정합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
code Required	결제수단 코드
name Required	PG 이름
display Required	결제수단 노출여부 T : 노출함 F : 노출안함

Request Copy

Response Copy

Points setting

적립금 설정(Points setting)은 적립금 사용에 필요한 설정값을 관리하기 위한 기능입니다.

Endpoints

GET /api/v2/admin/points/setting
PUT /api/v2/admin/points/setting

Points setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
point_issuance_standard	적립금 지급 기준 C: 배송완료 후 P: 구매확정 후
payment_period	적립금 지급 시점 적립금 지급 기준이 C: 배송완료 후 일때 1/3/7/14/20을 입력할 수 있습니다. 적립금 지급 기준이 P: 구매확정 후 일때 0/1/3/7/14/20을 입력할 수 있습니다.
name	적립금 명칭
format	적립금 표시 방식
round_unit	적립금 절사 단위 F : 절사안함 0.01 : 0.01단위 0.1 : 0.1단위 1 : 1단위 10 : 10단위 100 : 100단위 1000 : 1000단위
round_type	적립금 절사 방식 A : 내림 B : 반올림 C : 올림
display_type	적립금 항목 노출 설정 P : 정율 W : 정액 WP : 정액/정율 PW : 정율/정액
unusable_points_change_type	미가용 적립금 변환 기준 설정 M: 최초 상품 배송완료일/구매확정일 기준으로 적립 T: 마지막 상품 배송완료일/구매확정일 기준으로 적립

Retrieve points settings

GET /api/v2/admin/points/setting

GET

명칭, 지급 시점, 단위 등의 적립금 설정 값을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update points settings

PUT /api/v2/admin/points/setting

PUT

적립금 설정 값을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
point_issuance_standard	적립금 지급 기준 C: 배송완료 후 P: 구매확정 후
payment_period	적립금 지급 시점 적립금 지급 기준이 C: 배송완료 후 일때 1/3/7/14/20을 입력할 수 있습니다. 적립금 지급 기준이 P: 구매확정 후 일때 0/1/3/7/14/20을 입력할 수 있습니다.
name	적립금 명칭
format	적립금 표시 방식
round_unit	적립금 절사 단위 화폐단위가 "KRW" "JPY" "TWD" "VND"일때 "적립금 절사 단위"를 F/1/10/100/1000을 입력할 수 있습니다. 화폐단위가 "KRW" "JPY" "TWD" "VND"가 아닐때 "적립금 절사 단위"를 F/0.01/0.1/1/10을 입력할 수 있습니다.
round_type	적립금 절사 방식 A : 내림 B : 반올림 C : 올림
display_type	적립금 항목 노출 설정 P : 정율 W : 정액 WP : 정액/정율 PW : 정율/정액
unusable_points_change_type	미가용 적립금 변환 기준 설정 M: 최초 상품 배송완료일/구매확정일 기준으로 적립 T: 마지막 상품 배송완료일/구매확정일 기준으로 적립

Request Copy

Response Copy

Products setting

상품의 설정(Products setting)은 상품의 판매가 등의 설정값에 대한 기능입니다.

Endpoints

GET /api/v2/admin/products/setting

Products setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
calculate_price_based_on	판매가 계산 기준 S : 공급가 대비 마진율 A : 판매가 대비 마진율 P : 기본몰 판매가 B : 상품가
price_rounding_unit	판매가 계산 절사 단위 F : 절사안함 -2 : 0.01단위 -1 : 0.1단위 0 : 1단위 1 : 10단위 2 : 100단위 3 : 1000단위
price_rounding_rule	판매가 계산 절사 방법 L : 내림 U : 반올림 C : 올림

Retrieve product settings

GET /api/v2/admin/products/setting

GET

상품의 판매가에 대한 설정값을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Redirects

특정 URL로 접속 했을때, 설정한 URL로 리다이렉트할 수 있는 리소스입니다.

Endpoints

GET /api/v2/admin/redirects
POST /api/v2/admin/redirects
PUT /api/v2/admin/redirects/{id}
DELETE /api/v2/admin/redirects/{id}

Redirects properties

Attribute	Description
shop_no 최소값: [1] 최대값: [2147483647]	멀티쇼핑몰 번호
id 최대값: [2147483647]	리다이렉트 아이디
path	리다이렉트 경로
target	대상 위치

Retrieve a list of redirects

GET /api/v2/admin/redirects

GET

등록된 Redirect URL을 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	10

요청사양

Parameter	Description
shop_no 최소값: [1] 최대값: [2147483647]	멀티쇼핑몰 번호 DEFAULT 1
id 최소값: [1] 최대값: [2147483647]	리다이렉트 아이디
path	리다이렉트 경로
target	대상 위치

Request Copy

Response Copy

Create a redirect

POST /api/v2/admin/redirects

POST

Redirect URL을 등록할 수 있습니다.
샵별 최대 1000개 등록이 가능합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	10
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]
최대값: [2147483647]

멀티쇼핑몰 번호

DEFAULT 1

path
Required

리다이렉트 경로

target
Required

대상 위치

Request Copy

Response Copy

Update a redirect

PUT /api/v2/admin/redirects/{id}

PUT

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	10
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1] 최대값: [2147483647]	멀티쇼핑몰 번호 DEFAULT 1
id Required 최소값: [1] 최대값: [2147483647]	리다이렉트 아이디
path	리다이렉트 경로
target	대상 위치

Request Copy

Response Copy

Delete a redirect

DELETE /api/v2/admin/redirects/{id}

DELETE

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	10

요청사양

Parameter

Description

shop_no

최소값: [1]
최대값: [2147483647]

멀티쇼핑몰 번호

DEFAULT 1

id
Required

최소값: [1]
최대값: [2147483647]

리다이렉트 아이디

Request Copy

Response Copy

Seo setting

SEO 설정(Seo setting)은 검색결과 상위에 쇼핑몰이 노출되고 방문자가 증가하도록 하는 검색엔진 최적화(SEO) 작업입니다.

Endpoints

GET /api/v2/admin/seo/setting
PUT /api/v2/admin/seo/setting

Seo setting properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
common_page_title	공통페이지 title 태그
common_page_meta_description	공통페이지 description 태그
favicon URL	파비콘
use_google_search_console	구글 서치 콘솔 사용여부 T : 사용함 F : 사용안함
google_search_console	구글 서치 콘솔
use_naver_search_advisor	네이버 서치 어드바이저 사용여부 T : 사용함 F : 사용안함
naver_search_advisor	네이버 서치 어드바이저
sns_share_image URL	SNS 공유 이미지
use_twitter_card	트위터 카드 사용여부 T : 사용함 F : 사용안함
robots_text	검색로봇 접근 제어(PC)
mobile_robots_text	검색로봇 접근 제어(모바일)
use_missing_page_redirect	없는 페이지 연결 리다이렉션 여부(PC) T : 사용함 F : 사용안함
missing_page_redirect_url	없는 페이지 연결 리다이렉션 연결 경로(PC)
mobile_use_missing_page_redirect	없는 페이지 연결 리다이렉션 여부(모바일) T : 사용함 F : 사용안함
mobile_missing_page_redirect_url	없는 페이지 연결 리다이렉션 연결 경로(모바일)
use_sitemap_auto_update	사이트맵 사용여부 T : 사용함 F : 사용안함
use_rss	RSS 피드 사용여부 T : 사용함 F : 사용안함
display_group	메인분류 명
header_tag	Head HTML(PC)
footer_tag	Body HTML(PC)
mobile_header_tag	Head HTML(모바일)
mobile_footer_tag	Body HTML(모바일)

Retrieve SEO settings

GET /api/v2/admin/seo/setting

GET

쇼핑몰의 검색엔진 최적화(SEO) 설정을 조회합니다.
메타 태그, 파비콘, 검색로봇 접근 제어 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update store SEO settings

PUT /api/v2/admin/seo/setting

PUT

쇼핑몰의 검색엔진 최적화(SEO) 설정을 수정합니다.
메타 태그, 파비콘, 검색로봇 접근 제어 등을 설정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
common_page_title	공통페이지 title 태그
common_page_meta_description	공통페이지 description 태그
favicon URL	파비콘
use_google_search_console	구글 서치 콘솔 사용여부 T : 사용함 F : 사용안함
google_search_console	구글 서치 콘솔
use_naver_search_advisor	네이버 서치 어드바이저 사용여부 T : 사용함 F : 사용안함
naver_search_advisor	네이버 서치 어드바이저
sns_share_image URL	SNS 공유 이미지
use_twitter_card	트위터 카드 사용여부 T : 사용함 F : 사용안함
robots_text	검색로봇 접근 제어(PC)
mobile_robots_text	검색로봇 접근 제어(모바일)
use_missing_page_redirect	없는 페이지 연결 리다이렉션 여부(PC) T : 사용함 F : 사용안함
missing_page_redirect_url	없는 페이지 연결 리다이렉션 연결 경로(PC)
mobile_use_missing_page_redirect	없는 페이지 연결 리다이렉션 여부(모바일) T : 사용함 F : 사용안함
mobile_missing_page_redirect_url	없는 페이지 연결 리다이렉션 연결 경로(모바일)
use_sitemap_auto_update	사이트맵 사용여부 T : 사용함 F : 사용안함
use_rss	RSS 피드 사용여부 T : 사용함 F : 사용안함
display_group	메인분류 명
header_tag	Head HTML(PC)
footer_tag	Body HTML(PC)
mobile_header_tag	Head HTML(모바일)
mobile_footer_tag	Body HTML(모바일)

Request Copy

Response Copy

Shippingmanager

배송 관리자(Shippingmanager)는 배송 관리자 활성화 정보 관련 기능입니다.
배송 관리자의 사용 정보를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/shippingmanager

Shippingmanager properties

Attribute	Description
use	배송 관리자 활성화 정보

Retrieve activation information for Shipping Manager

GET /api/v2/admin/shippingmanager

GET

배송 관리자의 사용 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

Request Copy

Response Copy

Shops

멀티쇼핑몰(Shops)은 한개의 몰아이디에서 두개 이상의 쇼핑몰을 운영하고 있는 경우 생성한 멀티 쇼핑몰의 정보입니다.
멀티쇼핑몰은 최대 15개까지 생성이 가능하며, 각각 다른 언어와 화폐로 생성할 수 있어 다국어 쇼핑몰을 운영하기 용이합니다.

Endpoints

GET /api/v2/admin/shops
GET /api/v2/admin/shops/{shop_no}

Shops properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
default	기본샵 여부 기본샵 여부 구분 T : 기본샵 F : 기본샵 아님
shop_name 최대글자수 : [255자]	쇼핑몰명 해당 멀티쇼핑몰의 쇼핑몰 이름
business_country_code	사업자 거점 국가 코드 business_country_code
language_code	언어 코드 멀티쇼핑몰의 기본 언어 코드 ko_KR : 국문 en_US : 영문 zh_CN : 중문(간체) zh_TW : 중문(번체) ja_JP : 일문 vi_VN : 베트남어
language_name 최대글자수 : [20자]	기본 언어명 멀티쇼핑몰의 기본 언어명
currency_code 형식 : [A-Z]	결제 화폐 코드 멀티쇼핑몰의 결제 화폐 코드 South Korean Won (KRW) United States Dollar (USD) Japanese Yen (JPY) Chinese Yuan (CNY) Taiwan Dollar (TWD) Euro (EUR) Brazilian Real (BRL) Vietnamese Dong (VND)
currency_name	결제 화폐명 멀티쇼핑몰의 결제 화폐명
reference_currency_code 형식 : [A-Z]	참조 화폐 코드 멀티쇼핑몰의 참조 화폐 코드 South Korean Won (KRW) United States Dollar (USD) Japanese Yen (JPY) Chinese Yuan (CNY)
reference_currency_name	참조 화폐명 멀티쇼핑몰의 참조 화폐명
pc_skin_no	PC 쇼핑몰 대표 디자인 번호 멀티쇼핑몰의 PC 쇼핑몰 대표 디자인 번호. 현재 쇼핑몰에서 사용하고 있는 디자인 번호를 나타낸다.
mobile_skin_no	모바일 쇼핑몰 대표 디자인 번호 모바일 쇼핑몰 대표 디자인 번호. 현재 쇼핑몰에서 사용하고 있는 디자인 번호를 나타낸다.
base_domain 최대글자수 : [63자]	기본제공 도메인 기본제공하는 도메인
primary_domain 최대글자수 : [63자]	대표도메인 멀티쇼핑몰 대표 도메인
slave_domain	연결 도메인 쇼핑몰에 연결된 도메인
active	활성화 여부 멀티쇼핑몰 활성화 여부 T : 활성화 F : 비활성화
timezone	표준시간대(타임존)
timezone_name	표준시간대 정보
date_format	표준시간대 날짜 표시형식 년/월/일 : YYYY-MM-DD 월/일/년 : MM-DD-YYYY 일/월/년 : DD-MM-YYYY
time_format	표준시간대 시간 표시형식 시/분/초 표시 : hh:mm:ss 시/분 표시 : hh:mm
use_reference_currency	참조화폐 사용여부
is_https_active	HTTPS 활성화 여부 T : 활성화 F : 비활성화
site_connect	사이트 접속설정
channel	채널

Retrieve a list of shops

GET /api/v2/admin/shops

GET

쇼핑몰에 등록된 멀티쇼핑몰의 정보를 목록으로 조회할 수 있습니다.
쇼핑몰명, 기본샵 여부, 기본 언어명 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

Request Copy

Response Copy

Retrieve a shop

GET /api/v2/admin/shops/{shop_no}

GET

쇼핑몰에 등록된 멀티쇼핑몰의 정보를 조회할 수 있습니다.
쇼핑몰명, 언어, 결제 화폐정보 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no
Required

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

Request Copy

Response Copy

Sms setting

SMS 설정(Sms setting)은 쇼핑몰의 SMS 설정에 관한 기능입니다.
SMS API를 사용하기 위해서는 먼저 쇼핑몰에서 SMS 발송 서비스를 사용하고 있는지 확인이 필요합니다.

Endpoints

GET /api/v2/admin/sms/setting

Sms setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
use_sms	SMS 사용 여부 T: 사용함 F: 사용안함
exclude_unsubscriber	수신거부자 제외 발송 여부 T : 제외 F : 포함
default_sender	기본 발신번호
unsubscribe_phone	무료 수신거부 전화번호
send_method	SMS 발송방법 S: 단문 분할발송 L: 장문발송(3건 차감)

Retrieve SMS settings

GET /api/v2/admin/sms/setting

GET

쇼핑몰의 SMS 설정을 조회할 수 있습니다.
**해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Socials apple

애플아이디 로그인(Socials apple)은 쇼핑몰 이용 고객의 애플아이디 로그인에 관한 기능입니다.
애플아이디 로그인 설정을 사용하기 위해서는 먼저 애플의 개발자 계정에서 Sign in with Apple 앱 설정을 완료하여야 합니다.

Endpoints

GET /api/v2/admin/socials/apple
PUT /api/v2/admin/socials/apple

Socials apple properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
use_apple_login	애플 로그인 사용 T : 사용함 F : 사용안함
client_id	client id
team_id	Team ID
key_id	Key ID
auth_key_file_name	Auth Key 파일명
use_certification	애플 로그인 본인인증 T : 사용함 F : 사용안함

GET /api/v2/admin/socials/apple

GET

쇼핑몰 이용 고객의 애플 로그인 연동정보를 조회합니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

PUT /api/v2/admin/socials/apple

PUT

쇼핑몰 이용 고객의 애플 로그인 연동정보를 수정합니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
use_apple_login	애플 로그인 사용 T : 사용함 F : 사용안함
client_id 최대글자수 : [300자]	Client ID 애플 개발자 센터의 Service ID 생성 시 설정한 Identifier
team_id 최대글자수 : [300자]	Team ID 애플 개발자 센터의 App ID Prefix
key_id 최대글자수 : [300자]	Key ID 애플 개발자 센터의 Key ID
auth_key_file_name 최대글자수 : [30자]	Auth Key 파일명 App ID의 Key파일로 .p8파일만 가능
auth_key_file_contents 최대글자수 : [300자]	Auth Key 파일 내용 .p8파일을 텍스트 파일로 열어 줄바꿈 없이 값을 작성
use_certification	애플 로그인 본인인증 T : 사용함 F : 사용안함

Request Copy

Response Copy

Socials kakaosync

카카오싱크 SNS(Socials kakaosync)는 쇼핑몰의 카카오싱크에 대한 설정을 조회하거나 설정할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/socials/kakaosync
PUT /api/v2/admin/socials/kakaosync

Socials kakaosync properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
use_kakaosync	카카오싱크 사용여부 T : 사용함 F : 사용안함
rest_api_key	REST API 키
javascript_key	JavaScript 키
auto_login	자동 로그인 사용 카카오 웹브라우저로 쇼핑몰 이용시 카카오 아이디로 로그인 기능 사용 여부 T : 사용함 F : 사용안함
thirdparty_agree	제3자 제공 동의 여부 T : 동의함 F : 동의안함
thirdparty_agree_date	제3자 제공 동의 날짜
use_signup_result_page	쇼핑몰 가입 후 이동 페이지 T : 가입 완료 페이지로 이동 F : 가입 완료 페이지 없이 즉시 가입

Kakao Sync details

GET /api/v2/admin/socials/kakaosync

GET

쇼핑몰의 카카오싱크에 대한 설정을 조회할 수 있습니다.
카카오싱크 사용여부, 자동 로그인 사용여부 등을 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Kakao Sync updates

PUT /api/v2/admin/socials/kakaosync

PUT

카카오 웹브라우져에 대한 자동 로그인 기능의 사용여부를 수정할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
rest_api_key Required 형식 : [a-zA-Z0-9] 최대글자수 : [255자]	REST API 키
javascript_key Required 형식 : [a-zA-Z0-9] 최대글자수 : [255자]	JavaScript 키
auto_login	자동 로그인 사용 카카오 웹브라우저로 쇼핑몰 이용시 카카오 아이디로 로그인 기능 사용 여부 T : 사용함 F : 사용안함 DEFAULT F
use_signup_result_page	쇼핑몰 가입 후 이동 페이지 T : 가입 완료 페이지로 이동 F : 가입 완료 페이지 없이 즉시 가입 DEFAULT F

Request Copy

Response Copy

Socials naverlogin

네이버 로그인 설정정보를 조회하고 설정정보를 변경하는 리소스입니다.

Endpoints

GET /api/v2/admin/socials/naverlogin
PUT /api/v2/admin/socials/naverlogin

Socials naverlogin properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
use_naverlogin	네이버 로그인 사용여부
client_id	클라이언트 아이디
client_secret	클라이언트 시크릿 키

GET /api/v2/admin/socials/naverlogin

GET

쇼핑몰에 네이버 로그인 설정여부를 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

PUT /api/v2/admin/socials/naverlogin

PUT

쇼핑몰에 설정된 네이버 로그인 정보를 수정할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
use_naverlogin Required	네이버 로그인 사용여부 T:사용함 F:사용안함
client_id 형식 : [a-zA-Z0-9_-] 최대글자수 : [255자]	클라이언트 아이디
client_secret 형식 : [a-zA-Z0-9_-] 최대글자수 : [255자]	클라이언트 시크릿 키

Request Copy

Response Copy

Store

상점(Store)은 쇼핑몰의 쇼핑몰명, 관리자 정보, 사업자 등록번호와 고객센터 전화번호 등 쇼핑몰의 기본적인 정보를 확인할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/store

Store properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
shop_name	쇼핑몰명 해당 상점의 쇼핑몰명([쇼핑몰 설정 > 기본 설정 > '쇼핑몰 정보 > 내 쇼핑몰 정보'])
mall_id	상점 아이디 쇼핑몰 아이디. 대표운영자의 아이디이자, 쇼핑몰 기본 제공 도메인(mallid.cafe24.com)에 사용한다.
base_domain	기본제공 도메인 쇼핑몰 생성시 자동으로 생성되는 기본제공 도메인 정보. 해당 도메인을 통해 쇼핑몰에 접근할 수 있다.
primary_domain	대표도메인 쇼핑몰에 연결한 대표도메인. 대표도메인을 연결하였을 경우에만 노출된다.
company_registration_no	사업자등록번호 사업장이 위치한 국가에서 발급한 쇼핑몰의 사업자 등록 번호.
company_name	상호명 사업자 등록시 등록한 상호명 또는 법인명.
president_name	대표자명 사업자 등록시 등록한 대표자명.
company_condition	업태 사업자 등록시 등록한 업태.
company_line	종목 사업자 등록시 등록한 종목.
country	사업장 국가 사업장이 있는 국가명.
country_code	국가코드
zipcode	우편번호 사업장의 우편번호
address1	기본 주소 사업장 주소(시/군/도)
address2	상세 주소 사업장 주소(상세 주소)
phone	전화번호
fax	팩스번호
email	이메일 운영자가 자동메일을 수신할 경우 수신할 메일 주소
notification_only_email	발신전용 이메일 고객과 운영자에게 자동메일 발송시 보내는 사람 메일주소
mall_url	쇼핑몰 주소
mail_order_sales_registration	통신 판매업 신고 통신판매업 신고가 되었는지 신고 여부 T : 신고함 F : 신고안함
mail_order_sales_registration_number	통신판매신고 번호
missing_report_reason_type	통신판매업 미신고 사유 통신판매업 신고를 하지 않았을 경우 해당 사유.
missing_report_reason	통신판매업 미신고 사유 상세 내용 통신판매업 미신고 사유가 "기타"일 경우 상세 사유.
about_us_contents	회사소개 쇼핑몰에 대한 간략한 소개 표시. 쇼핑몰의 회사 소개 화면에 표시된다.
company_map_url	회사약도 쇼핑몰에 대한 간략한 약도 표시. 쇼핑몰의 회사 소개 화면에 표시된다.
customer_service_phone	고객센터 상담/주문 전화 쇼핑몰 화면에 표시되는 고객센터 상담 전화
customer_service_email	고객센터 상담/주문 이메일 쇼핑몰 화면에 표시되는 고객센터 상담 이메일 주소.
customer_service_fax	고객센터 팩스 번호 쇼핑몰 화면에 표시되는 고객센터 팩스 번호.
customer_service_sms	고객센터 SMS 수신번호 쇼핑몰 화면에 표시되는 고객센터 SMS 수신 번호.
customer_service_hours	고객센터 운영시간 쇼핑몰 화면에 표시되는 고객센터 운영시간.
privacy_officer_name	개인정보보호 책임자명 쇼핑몰 화면에 표시되는 개인정보보호 책임자 이름.
privacy_officer_position	개인정보보호 책임자 지위
privacy_officer_department	개인정보보호 책임자 부서
privacy_officer_phone	개인정보보호 책임자 연락처 쇼핑몰 화면에 표시되는 개인정보보호 책임자의 전화번호.
privacy_officer_email	개인정보보호 책임자 이메일 쇼핑몰 화면에 표시되는 개인정보보호 책임자의 이메일 주소.
contact_us_mobile	서비스 문의안내 모바일 표시여부 서비스 문의 안내를 모바일에 노출시킬 것인지 여부. T : 표시함 F : 표시안함
contact_us_contents	서비스 문의안내 내용 상품상세 페이지에 노출시키는 서비스 문의 안내 내용.
sales_product_categories	판매 상품 카테고리 회원가입 및 쇼핑몰 생성 직후 입력하는 판매 상품 카테고리의 정보를 조회할 수 있습니다. (2023년 4월 이후 가입한 몰에 한하여 조회할 수 있습니다.) Undecided : 아직 결정하지 못했어요. Apparel : 패션의류 FashionAccessories : 패션잡화 LuxuryGoods : 수입명품 BrandApparel : 브랜드의류 BrandAccessories : 브랜드잡화 Food_Beverage : 식품 Lifestyle_HealthCare : 생활/건강 Furniture_HomeDecor : 가구/인테리어 Beauty_PersonalCare : 화장품/미용 Maternity_BabyProducts : 출산/육아 Digital_HomeAppliances : 디지털/가전 CarAccessories : 자동차 Rentals : 렌탈 서비스 Sports_Leisure : 스포츠/레저 CD_DVD : 음반/DVD Books : 도서 Travels_Services : 여가/생활편의 Used_Refurbished_Exhibition : 중고/리퍼/전시 Others : 기타/서비스

Retrieve store details

GET /api/v2/admin/store

GET

쇼핑몰의 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

Request Copy

Response Copy

Store accounts

상점 계좌(Store accounts)는 쇼핑몰의 무통장입금 정보에 대한 기능입니다.

Endpoints

GET /api/v2/admin/store/accounts

Store accounts properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
bank_account_id	무통장 입금 은행 ID
bank_name	은행명
bank_code 최대글자수 : [50자]	은행코드 bank_code
bank_account_no	계좌번호
bank_account_holder	예금주
use_account	사용여부 T : 사용함 F : 사용안함

Retrieve a list of store bank accounts

GET /api/v2/admin/store/accounts

GET

상점의 무통장입금 계좌정보를 목록으로 조회할 수 있습니다.
은행명, 은행코드, 계좌번호 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Subscription shipments setting

정기배송 설정(Subscription shipments setting)은 정기결제를 통해 이루어지는 정기배송에 대한 기능입니다.
정기배송 설정을 통해 쇼핑몰의 정기배송 상품을 설정하거나 정기배송 상품을 조회할 수 있습니다.
정기배송 기능을 사용하기 위해서는 먼저 정기배송 서비스가 신청되어 있어야 합니다.
정기배송 서비스의 신청은 어드민에서 가능합니다.

Endpoints

GET /api/v2/admin/subscription/shipments/setting
POST /api/v2/admin/subscription/shipments/setting
PUT /api/v2/admin/subscription/shipments/setting/{subscription_no}
DELETE /api/v2/admin/subscription/shipments/setting/{subscription_no}

Subscription shipments setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
subscription_no	정기배송 상품설정 번호
subscription_shipments_name	정기배송 상품설정 명
product_binding_type	정기배송 상품 설정 A : 전체상품 P : 개별상품 C : 상품분류
one_time_purchase	1회구매 제공여부 T : 제공함 F : 제공안함
product_list	적용 상품
category_list	적용 분류
use_discount	정기배송 할인 사용여부 T : 사용함 F : 사용안함
discount_value_unit	할인 기준 P : 할인율 W : 할인 금액
discount_values	할인 값
related_purchase_quantity	구매수량 관계 여부 T : 구매수량에 따라 F : 구매수량에 관계없이
subscription_shipments_cycle_type	배송주기 제공여부 T : 사용함 F : 사용안함
subscription_shipments_cycle	배송주기 1W : 1주 2W : 2주 3W : 3주 4W : 4주 1M : 1개월 2M : 2개월 3M : 3개월 4M : 4개월 5M : 5개월 6M : 6개월 1Y : 1년
use_order_price_condition	혜택제공금액기준 사용여부 T : 사용함 F : 사용안함
order_price_greater_than	혜택제공금액기준 제공 기준금액
include_regional_shipping_rate	지역별배송비 포함여부 T : 포함 F : 미포함
shipments_start_date 최소값: [1] 최대값: [30]	배송시작일 설정

Retrieve a list of subscription products

GET /api/v2/admin/subscription/shipments/setting

GET

설정된 정기배송 상품에 대한 정보를 목록으로 조회할 수 있습니다.
정기배송 상품설정 번호, 설정 명, 설정값 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

subscription_no

정기배송 상품설정 번호

Request Copy

Response Copy

Create a subscription payment rule

POST /api/v2/admin/subscription/shipments/setting

POST

정기배송 상품을 설정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
subscription_shipments_name Required 최대글자수 : [255자]	정기배송 상품설정 명
product_binding_type Required	정기배송 상품 설정 A : 전체상품 P : 개별상품 C : 상품분류
one_time_purchase	1회구매 제공여부 T : 제공함 F : 제공안함 DEFAULT T
product_list 배열 최대사이즈: [10000]	적용 상품
category_list 배열 최대사이즈: [1000]	적용 분류
use_discount Required	정기배송 할인 사용여부 T : 사용함 F : 사용안함
discount_value_unit	할인 기준 P : 할인율 W : 할인 금액
discount_values 배열 최대사이즈: [40]	할인 값 discount_value_unit이 P일 경우 최대값 : 100 discount_value_unit이 W일 경우 최대값 : 99999999999999
related_purchase_quantity	구매수량 관계 여부 T : 구매수량에 따라 F : 구매수량에 관계없이
subscription_shipments_cycle_type Required	배송주기 제공여부 T : 사용함 F : 사용안함
subscription_shipments_cycle Required	배송주기 1W : 1주 2W : 2주 3W : 3주 4W : 4주 1M : 1개월 2M : 2개월 3M : 3개월 4M : 4개월 5M : 5개월 6M : 6개월 1Y : 1년
use_order_price_condition Required	혜택제공금액기준 사용여부 T : 사용함 F : 사용안함
order_price_greater_than 최대값: [99999999999999]	혜택제공금액기준 제공 기준금액
include_regional_shipping_rate	지역별배송비 포함여부 T : 포함 F : 미포함
shipments_start_date 최소값: [1] 최대값: [30]	배송시작일 설정 DEFAULT 3

Request Copy

Response Copy

Update subscription products

PUT /api/v2/admin/subscription/shipments/setting/{subscription_no}

PUT

설정된 정기배송 상품의 정기배송 설정을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
subscription_no Required	정기배송 상품설정 번호
subscription_shipments_name 최대글자수 : [255자]	정기배송 상품설정 명
product_binding_type	정기배송 상품 설정 A : 전체상품 P : 개별상품 C : 상품분류
one_time_purchase	1회구매 제공여부 T : 제공함 F : 제공안함
product_list 배열 최대사이즈: [10000]	적용 상품
category_list 배열 최대사이즈: [1000]	적용 분류
use_discount	정기배송 할인 사용여부 T : 사용함 F : 사용안함
discount_value_unit	할인 기준 P : 할인율 W : 할인 금액
discount_values 배열 최대사이즈: [40]	할인 값
related_purchase_quantity	구매수량 관계 여부 T : 구매수량에 따라 F : 구매수량에 관계없이
subscription_shipments_cycle_type	배송주기 제공여부 T : 사용함 F : 사용안함
subscription_shipments_cycle	배송주기 1W : 1주 2W : 2주 3W : 3주 4W : 4주 1M : 1개월 2M : 2개월 3M : 3개월 4M : 4개월 5M : 5개월 6M : 6개월 1Y : 1년
use_order_price_condition	혜택제공금액기준 사용여부 T : 사용함 F : 사용안함
order_price_greater_than 최대값: [99999999999999]	혜택제공금액기준 제공 기준금액
include_regional_shipping_rate	지역별배송비 포함여부 T : 포함 F : 미포함
shipments_start_date 최소값: [1] 최대값: [30]	배송시작일 설정

Request Copy

Response Copy

Delete subscription products

DELETE /api/v2/admin/subscription/shipments/setting/{subscription_no}

DELETE

설정된 정기배송 상품의 정기배송 설정을 해제할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 쓰기권한 (mall.write_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

subscription_no
Required

정기배송 상품설정 번호

Request Copy

Response Copy

Taxmanager

세금 관리자(MSA)의 활성화 정보 관련 기능입니다.

Endpoints

GET /api/v2/admin/taxmanager

Taxmanager properties

Attribute	Description
use	세금 관리자 활성화 정보

Retrieve activation information for Tax Manager

GET /api/v2/admin/taxmanager

GET

세금 관리자의 사용 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

Request Copy

Response Copy

Users

운영자(Users)는 쇼핑몰의 대표관리자와 더불어 쇼핑몰을 운영할 수 있는 운영자와 관련된 기능입니다.
부운영자는 대표관리자가 부여한 권한 내에서 쇼핑몰을 운영할 수 있습니다.
쇼핑몰에 등록된 운영자를 목록으로 조회하거나 특정 운영자를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/users
GET /api/v2/admin/users/{user_id}

Users properties

Attribute	Description
user_id	운영자 아이디 운영자 혹은 부운영자의 아이디
user_name	운영자 명 운영자 혹은 부운영자의 이름
phone 전화번호	전화번호 운영자 혹은 부운영자의 전화번호
email 이메일	이메일 운영자 혹은 부운영자의 이메일 주소
ip_restriction_type	IP 접근제한 IP 접근제한의 사용여부 A : 사용함 F : 사용안함
admin_type	운영자 구분 대표운영자인지 부운영자인지의 구분 P : 대표운영자 A : 부운영자
last_login_date	최근 접속일시
shop_no 최소값: [1]	멀티쇼핑몰 번호
nick_name	운영자 별명 운영자의 별명
nick_name_icon_type	별명 아이콘 타입 별명 아이콘 등록. 직접 등록이나 샘플 등록이 가능함. D : 직접 아이콘 등록 S : 샘플 아이콘 등록
nick_name_icon_url	별명 아이콘 URL
board_exposure_setting	게시판 노출 설정
memo	메모
available	사용여부 T : 사용함 F : 사용안함
multishop_access_authority	멀티쇼핑몰 접근 권한 T : 허용함 F : 허용안함
menu_access_authority	메뉴 접근 권한
detail_authority_setting	상세 권한 설정
ip_access_restriction	IP 접근 제한
access_permission	접속 허용 권한 T : 접속 허용시간 설정과 상관없이 항상 관리자 페이지 접속을 허용함 F : 사용안함

Retrieve a list of admin users

GET /api/v2/admin/users

GET

쇼핑몰에 등록된 운영자를 목록으로 조회할 수 있습니다.
운영자 아이디, 운영자명, 이메일, 전화번호 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

search_type

검색 타입

member_Id : 회원 아이디
name : 이름

keyword

검색어

admin_type

운영자 구분

P : 대표운영자
A : 부운영자

Request Copy

Response Copy

Retrieve admin user details

GET /api/v2/admin/users/{user_id}

GET

쇼핑몰에 등록된 특정 운영자를 조회할 수 있습니다.
운영자 이름, 전화번호, 이메일 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상점 읽기권한 (mall.read_store)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

user_id

운영자 아이디

운영자 혹은 부운영자의 아이디

Request Copy

Response Copy

Bundleproducts

세트상품(Bunldeproducts)은 여러 개의 상품을 묶어서 판매하는 상품을 의미합니다.
세트 상품은 상품을 각각 주문하는 것보다 더 싸게 구입할 수 있도록 추가 할인을 설정할 수 있습니다.
세트상품 주문시에는 하나의 상품처럼 주문을 관리할 수 있습니다.
세트상품 리소스에서는 세트상품만 조회하거나, 세트상품 등록/수정/삭제를 진행할 수 있습니다.

Endpoints

GET /api/v2/admin/bundleproducts
GET /api/v2/admin/bundleproducts/{product_no}
POST /api/v2/admin/bundleproducts
PUT /api/v2/admin/bundleproducts/{product_no}
DELETE /api/v2/admin/bundleproducts/{product_no}

Bundleproducts properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
product_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	상품코드 시스템이 상품에 부여한 코드. 해당 쇼핑몰 내에서 상품코드는 중복되지 않음.
bundle_product_components	세트상품의 구성상품 정보
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
product_name 최대글자수 : [250자]	상품명 상품의 이름. 상품명은 상품을 구분하는 가장 기초적인 정보이며 검색 정보가 된다. HTML을 사용하여 입력이 가능하다.
eng_product_name 최대글자수 : [250자]	영문 상품명 상품의 영문 이름. 해외 배송 등에 사용 가능함.
supply_product_name 최대글자수 : [250자]	공급사 상품명 공급사에서 등록한 상품의 이름. 공급사에서 상품의 구분을 위해 임의로 입력할 수 있으며 상품명에는 영향을 미치지 않는다.
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명 상품의 모델명.
display	진열상태 상품을 쇼핑몰에 진열할지 여부. 상품을 쇼핑몰에 진열할 경우 설정한 상품분류와 메인화면에 표시된다. 상품이 쇼핑몰에 진열되어 있지 않으면 쇼핑몰 화면에 표시되지 않아 접근할 수 없으며 상품을 구매할 수 없다. T : 진열함 F : 진열안함
selling	판매상태 상품을 쇼핑몰에 판매할지 여부. 상품을 진열한 상태로 판매를 중지할 경우 상품은 쇼핑몰에 표시되지만 "품절"로 표시되어 상품을 구매할 수 없다. 상품이 "진열안함"일 경우 "판매함" 상태여도 상품에 접근할 수 없기 때문에 구매할 수 없다. T : 판매함 F : 판매안함
product_condition	상품 상태 판매하는 상품의 상태 표시. N : 신상품 B : 반품상품 R : 재고상품 U : 중고상품 E : 전시상품 F : 리퍼상품 S : 스크래치 상품
product_used_month 최대값: [2147483647]	중고상품 사용 개월
summary_description 최대글자수 : [255자]	상품요약설명 상품에 대한 요약 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다. [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 노출되도록 설정 가능하다.
product_tag	상품 검색어 검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그)
price_content 최대글자수 : [20자]	판매가 대체문구 상품의 가격 대신 표시되는 문구. 품절이나 상품이 일시적으로 판매 불가할 때 사용.
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함
buy_limit_type	구매제한 해당 상품을 구매할 수 있는 회원 정보 표시. N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함 O : 지정된 회원만 구매하며 구매버튼 감추기 D : 지정된 회원만 구매하며 구매버튼 보이기
buy_group_list	구매가능 회원 등급
buy_member_id_list	구매가능 회원아이디
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. T : 사용함 F : 사용안함
detail_image	상세이미지 상품 상세 화면에 표시되는 상품 이미지.
list_image	목록이미지 상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.
tiny_image	작은목록이미지 최근 본 상품 영역에 표시되는 상품의 목록 이미지.
small_image	축소이미지 상품 상세 화면 하단에 표시되는 상품 목록 이미지.
use_naverpay	네이버페이 사용여부 T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
icon_show_period	아이콘 노출 기간 상품에 설정한 아이콘이 노출되는 기간.
icon 배열 최대사이즈: [5]	아이콘 상품에 표시되는 아이콘. 상품 판매를 강조하기 위한 목적으로 사용이 가능함.
hscode	HS코드 해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함. ※ HS코드 : 세계무역기구(WTO) 및 세계관세기구(WCO)가 무역통계 및 관세분류의 목적상 수출입 상품을 숫자 코드로 분류화 한 것으로, 수입 시 세금부과와 수출품의 통제 및 통계를 위한 분류법
product_weight	상품 중량 상품의 전체 중량(kg). 배송을 위해 상품 자체의 무게와 박스 무게, 포장무게를 모두 포함한 중량 기재가 필요하다.
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
created_date	생성일 상품이 생성된 일시.
updated_date	수정일 상품이 수정된 일시.
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
list_icon	추천 / 품절 / 신상품 아이콘 노출 여부 추천, 품절, 신상품 아이콘을 목록에서 표시하는지 여부 ※ 품절 아이콘 ● 상품이 품절 상태임을 알려주는 아이콘 ● 재고관리 및 품절 기능을 사용하는 상품에 대해 재고가 없을 경우 표시 ※ 추천, 신상품 아이콘 ● 상품분류나 메인화면의 추천상품, 신상품 영역에 진열된 상품인 경우, 설정에 따라 해당 아이콘을 표시함 ※ 아이콘 노출 여부 설정위치 : [쇼핑몰 설정 > 상품 설정 > '상품 정책 설정 > 상품 관련 설정 > 상품 아이콘 설정']
sold_out	품절여부 T : 품절 F : 품절아님
discountprice	상품 할인판매가 리소스
decorationimages	꾸미기 이미지 리소스
benefits	혜택 리소스
additionalimages 배열 최대사이즈: [20]	추가 이미지 리소스
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시
exposure_group_list	표시대상 회원 등급
bundle_product_sales	세트할인 정보
category	분류 번호 해당 상품이 진열되어있는 상품 분류.
project_no	기획전 번호
description	상품상세설명 상품에 보다 상세한 정보가 포함되어있는 설명. HTML을 사용하여 입력이 가능하다.
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
separated_mobile_description	모바일 별도 등록 T : 직접등록 F : 상품 상세설명 동일
additional_image 배열 최대사이즈: [20]	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 특정 상품 상세 조회 API에서만 확인 가능하다.
payment_info	상품결제안내 상품의 결제 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
shipping_info	상품배송안내 상품의 배송 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
exchange_info	교환/반품안내 상품의 교환/반품 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
service_info	서비스문의/안내 제품의 사후 고객 서비스 방법 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
country_hscode	국가별 HS 코드 해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함. 국가별로 HS 코드의 표준이 다르기 때문에 해당 국가에 맞는 코드 입력이 필요함.
simple_description	상품 간략 설명 상품에 대한 간략한 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다. [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 노출되도록 설정 가능하다.
shipping_calculation	배송 계산 유형 A : 자동 계산 M : 수동 계산
shipping_fee_by_product	개별배송여부 상품에 배송비를 개별적으로 부과할 것인지 공통 배송비를 부과할 것인지에 대한 설정. 개별 배송비를 사용하지 않을 경우 공통 배송비를 사용함. shipping_calculation이 A(자동계산)일 경우 null로 반환. T : 사용함 F : 사용안함
shipping_method	배송방법 (개별배송비를 사용할 경우) 배송 수단 및 방법 shipping_calculation이 A(자동계산)일 경우 null로 반환. 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음
prepaid_shipping_fee	배송비 선결제 설정 shipping_calculation이 A(자동계산)일 경우 null로 반환. C : 착불 P : 선결제 B : 선결제/착불
shipping_period	배송기간 (개별배송비를 사용할 경우) 상품 배송시 평균적으로 소요되는 배송 기간. shipping_calculation이 A(자동계산)일 경우 null로 반환.
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가. shipping_calculation이 A(자동계산)일 경우 null로 반환. A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_area 최대글자수 : [255자]	배송지역 (개별배송비를 사용할 경우) 상품을 배송할 수 있는 지역. shipping_calculation이 A(자동계산)일 경우 null로 반환.
shipping_fee_type	배송비 타입 (개별배송비를 사용할 경우) 상품의 배송비 타입. shipping_calculation이 A(자동계산)일 경우 null로 반환. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_rates	구간별 배송비 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비 shipping_calculation이 A(자동계산)일 경우 null로 반환.
clearance_category_eng	해외통관용 상품구분 영문명 해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 국문명 입력시 입력한 구분명이 자동으로 번역된 항목. 번역된 영문명이 해외송장 상품명에 포함되어 전송됨.
clearance_category_kor	해외통관용 상품구분 국문명 해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 자동으로 영문으로 번역되어 해외송장 상품명 정보에 포함하여 전송.
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드
additional_information	추가항목 [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 추가한 추가항목. 기본적인 상품 정보 외에 추가로 표시항 항목이 있을 때 추가하여 사용함.
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.
memos	메모 리소스
hits	상품 조회수 리소스
seo	상품 Seo 리소스
tags	상품 태그 리소스

Retrieve a list of bundles

GET /api/v2/admin/bundleproducts

GET

세트상품을 목록을 통해 조회할 수 있습니다.
상품코드, 자체상품 코드, 상품명 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
discountprice embed	상품 할인판매가 리소스
decorationimages embed	꾸미기 이미지 리소스
benefits embed	혜택 리소스
additionalimages embed	추가 이미지 리소스
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no	상품번호 조회하고자 하는 상품의 번호 ,(콤마)로 여러 건을 검색할 수 있다.
display	진열상태 T : 진열함 F : 진열안함
selling	판매상태 T : 판매함 F : 판매안함
product_code	상품코드 ,(콤마)로 여러 건을 검색할 수 있다.
product_tag	상품 검색어 ,(콤마)로 여러 건을 검색할 수 있다.
custom_product_code	자체상품 코드 ,(콤마)로 여러 건을 검색할 수 있다.
product_name	상품명 ,(콤마)로 여러 건을 검색할 수 있다.
eng_product_name	영문 상품명 ,(콤마)로 여러 건을 검색할 수 있다.
supply_product_name	공급사 상품명 ,(콤마)로 여러 건을 검색할 수 있다.
internal_product_name	상품명(관리용) ,(콤마)로 여러 건을 검색할 수 있다.
model_name	모델명 ,(콤마)로 여러 건을 검색할 수 있다.
price_min	상품 판매가 검색 최소값
price_max	상품 판매가 검색 최대값
created_start_date	상품 등록일 검색 시작일
created_end_date	상품 등록일 검색 종료일
updated_start_date	상품 수정일 검색 시작일
updated_end_date	상품 수정일 검색 종료일
category	분류 번호
category_unapplied	미적용 분류 검색 T: 미적용 분류 검색
include_sub_category	하위분류 포함 검색 T: 포함
product_weight	상품 중량
additional_information_key	추가항목 검색조건 키
additional_information_value	추가항목 검색조건 값
sort	정렬 순서 값 created_date : 등록일 updated_date : 수정일 product_name : 상품명
order	정렬 순서 asc : 순차정렬 desc : 역순 정렬
offset 최대값: [8000]	조회결과 시작위치 조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Request Copy

Response Copy

Retrieve a bundle

GET /api/v2/admin/bundleproducts/{product_no}

GET

특정 세트상품을 상세조회할 수 있습니다.
세트할인 정보와 같은 상세 정보를 추가로 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 조회하고자 하는 상품의 번호
discountprice embed	상품 할인판매가 리소스
decorationimages embed	꾸미기 이미지 리소스
benefits embed	혜택 리소스
memos embed	메모 리소스
hits embed	상품 조회수 리소스
seo embed	상품 Seo 리소스
tags embed	상품 태그 리소스
additionalimages embed	추가 이미지 리소스

Request Copy

Response Copy

Create a bundle

POST /api/v2/admin/bundleproducts

POST

세트상품을 생성할 수 있습니다.
구성상품을 묶은 가격에 대해 추가로 세트상품 할인을 적용할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_name Required 최대글자수 : [250자]	상품명
bundle_product_components Required	세트상품의 구성상품 정보
product_no Required 세트상품의 구성상품 번호 purchase_quantity Required 세트상품 구매개수
bundle_product_sales Required	세트할인 정보
discount_value Required 세트상품 할인가 discount_type Required 세트상품 할인타입 P : 퍼센트 V : 정액 discount_round_unit 세트상품 할인 절사 단위 F : 절사안함 -2 : 0.01단위 -1 : 0.1단위 0 : 1단위 1 : 10단위 2 : 100단위 3 : 1000단위 discount_round_type 세트상품 할인 절사 방식 F : 내림 R : 반올림 C : 올림
display	진열상태 T : 진열함 F : 진열안함 DEFAULT F
add_category_no	추가 분류 번호 분류 번호를 사용하여 진열을 원하는 카테고리에 상품 등록
category_no Required 분류 번호 recommend 추천상품 분류 등록 여부 T : 추천상품 등록 F : 추천상품 등록안함 DEFAULT F new 신상품 분류 등록 여부 T : 신상품 등록 F : 신상품 등록안함 DEFAULT F
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
eng_product_name 최대글자수 : [250자]	영문 상품명
supply_product_name 최대글자수 : [250자]	공급사 상품명
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명
use_naverpay	네이버페이 사용여부 EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
product_weight 최소: [0]~최대: [999999.99]	상품 중량
description	상품상세설명
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
summary_description 최대글자수 : [255자]	상품요약설명
simple_description	상품 간략 설명
product_tag 배열 최대사이즈: [50]	상품 검색어
payment_info	상품결제안내
shipping_info	상품배송안내
exchange_info	교환/반품안내
service_info	서비스문의/안내
icon 배열 최대사이즈: [5]	아이콘
hscode 최대글자수 : [20자]	HS코드 배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력 shipping_calculation이 A(자동계산)일 경우 필수 입력 아님
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가. ※ 쇼핑몰이 EC Global 쇼핑몰일 경우 "C"를 필수로 입력해야한다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. A : 국내배송 C : 해외배송 B : 국내/해외배송 DEFAULT A
shipping_method	배송방법 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음 DEFAULT 01
shipping_fee_by_product	개별배송여부 T : 개별배송 F : 기본배송 DEFAULT F
shipping_area 최대글자수 : [255자]	배송지역
shipping_period 배열 최대사이즈: [2]	배송기간
minimum 최소 기간 DEFAULT 1 maximum 최대 기간 DEFAULT 7
shipping_fee_type	배송비 타입 개별배송비를 사용할 경우 상품의 배송비 타입. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과 DEFAULT T
shipping_rates 배열 최대사이즈: [200]	배송비 금액 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비
prepaid_shipping_fee	배송비 선결제 설정 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 착불 P : 선결제 B : 선결제/착불 DEFAULT B
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드 배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력 shipping_calculation이 A(자동계산)일 경우 필수 입력 아님 clearance_category_code
detail_image	상세이미지
list_image	목록이미지
tiny_image	작은목록이미지
small_image	축소이미지
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록 DEFAULT A
additional_information	추가항목
key Required 추가항목 키 value 추가항목 값
price_content 최대글자수 : [20자]	판매가 대체문구
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함 DEFAULT F
buy_limit_type	구매제한 N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함 O : 지정된 회원만 구매하며 구매버튼 감추기 D : 지정된 회원만 구매하며 구매버튼 보이기 DEFAULT F
buy_group_list	구매가능 회원 등급
buy_member_id_list	구매가능 회원아이디
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함 DEFAULT F
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함 DEFAULT F
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정 DEFAULT F
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함 DEFAULT F
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.
product_no Required 상품번호 interrelated Required 관련상품 상호등록 여부 T : 상호등록 F : 일방등록
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
additional_image	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 추가이미지는 최대 20개까지 등록 가능하다.
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. [쇼핑몰 설정 > 고객 설정 > '회원 정책 설정 > 회원 관련 설정 > 회원가입 및 본인인증 설정'] 에서 성인인증 사용 시 구매차단 설정이 사용함이어야 성인인증이 적용된다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함 DEFAULT F
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시 DEFAULT A
exposure_group_list	표시대상 회원 등급

Request Copy

Response Copy

Update a bundle

PUT /api/v2/admin/bundleproducts/{product_no}

PUT

특정 세트상품의 정보를 수정할 수 있습니다.
상품명, 세트상품의 구성상품 정보, 세트할인 정보 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
product_name 최대글자수 : [250자]	상품명
bundle_product_components	세트상품의 구성상품 정보
product_no Required 세트상품의 구성상품 번호 purchase_quantity Required 세트상품 구매개수
bundle_product_sales	세트할인 정보
discount_value Required 세트상품 할인가 discount_type Required 세트상품 할인타입 P : 퍼센트 V : 정액 discount_round_unit 세트상품 할인 절사 단위 F : 절사안함 -2 : 0.01단위 -1 : 0.1단위 0 : 1단위 1 : 10단위 2 : 100단위 3 : 1000단위 discount_round_type 세트상품 할인 절사 방식 F : 내림 R : 반올림 C : 올림
display	진열상태 상품을 쇼핑몰에 진열할지 여부 변경. T : 진열함 F : 진열안함
product_condition	상품 상태 N : 신상품 B : 반품상품 R : 재고상품 U : 중고상품 E : 전시상품 F : 리퍼상품 S : 스크래치 상품
product_used_month 최대값: [2147483647]	중고상품 사용 개월 상품 상태(product_condition)가 중고 상품일 경우 중고 상품의 사용 개월 수
add_category_no	추가 분류 번호 상품분류 번호를 입력하여 해당 상품에 특정 상품분류를 추가 등록
category_no Required 분류 번호 recommend 추천상품 분류 등록 여부 T : 추천상품 등록 F : 추천상품 등록안함 DEFAULT F new 신상품 분류 등록 여부 T : 신상품 등록 F : 신상품 등록안함 DEFAULT F
delete_category_no	삭제 분류 번호 상품분류 번호를 입력하여 해당 상품에 특정 상품분류 삭제
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
eng_product_name 최대글자수 : [250자]	영문 상품명
supply_product_name 최대글자수 : [250자]	공급사 상품명
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명
use_naverpay	네이버페이 사용여부 EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
product_weight 최소: [0]~최대: [999999.99]	상품 중량
description	상품상세설명
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
summary_description 최대글자수 : [255자]	상품요약설명
simple_description	상품 간략 설명
product_tag 배열 최대사이즈: [50]	상품 검색어
payment_info	상품결제안내
shipping_info	상품배송안내
exchange_info	교환/반품안내
service_info	서비스문의/안내
icon 배열 최대사이즈: [5]	아이콘
use_icon_exposure_term	표시기간 사용 여부 T : 사용함 F : 사용안함
icon_exposure_begin_datetime	표시기간 시작 일자
icon_exposure_end_datetime	표시기간 종료 일자
hscode 최대글자수 : [20자]	HS코드 배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력 shipping_calculation이 A(자동계산)일 경우 필수 입력 아님
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별배송료 설정이 사용안함인 경우 설정 불가. EC 베트남, 필리핀 버전에서는 사용할 수 없음. A : 국내배송 C : 해외배송 B : 국내/해외배송
prepaid_shipping_fee	배송비 선결제 설정 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 착불 P : 선결제 B : 선결제/착불
shipping_method	배송방법 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음
shipping_fee_by_product	개별배송여부 T : 개별배송 F : 기본배송
shipping_area 최대글자수 : [255자]	배송지역
shipping_period 배열 최대사이즈: [2]	배송기간
minimum 최소 기간 DEFAULT 1 maximum 최대 기간 DEFAULT 7
shipping_fee_type	배송비 타입 개별배송비를 사용할 경우 상품의 배송비 타입. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_rates	배송비 금액 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드 배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력 shipping_calculation이 A(자동계산)일 경우 필수 입력 아님 clearance_category_code
detail_image	상세이미지
list_image	목록이미지
tiny_image	작은목록이미지
small_image	축소이미지
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록
additional_information	추가항목
key Required 추가항목 키 value 추가항목 값
price_content 최대글자수 : [20자]	판매가 대체문구
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함
buy_limit_type	구매제한 N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함 O : 지정된 회원만 구매하며 구매버튼 감추기 D : 지정된 회원만 구매하며 구매버튼 보이기
buy_group_list	구매가능 회원 등급
buy_member_id_list	구매가능 회원아이디
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.
product_no 상품번호 interrelated Required 관련상품 상호등록 여부 T : 상호등록 F : 일방등록
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
additional_image	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 추가이미지는 최대 20개까지 등록 가능하다.
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. [쇼핑몰 설정 > 고객 설정 > '회원 정책 설정 > 회원 관련 설정 > 회원가입 및 본인인증 설정'] 에서 성인인증 사용 시 구매차단 설정이 사용함이어야 성인인증이 적용된다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시
exposure_group_list	표시대상 회원 등급

Request Copy

Response Copy

Delete a bundle

DELETE /api/v2/admin/bundleproducts/{product_no}

DELETE

특정 세트상품을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Request Copy

Response Copy

Categories products

카테고리 상품(Categories products)은 카테고리의 상품의 표시 순서, 고정 여부, 진열 영역 등을 조회, 수정할 수 있는 관계형 리소스입니다.

Endpoints

GET /api/v2/admin/categories/{category_no}/products
GET /api/v2/admin/categories/{category_no}/products/count
POST /api/v2/admin/categories/{category_no}/products
PUT /api/v2/admin/categories/{category_no}/products
DELETE /api/v2/admin/categories/{category_no}/products/{product_no}

Categories products properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
sequence_no	표시 순서
auto_sort	자동 정렬 여부
sold_out	품절여부
fixed_sort	고정 여부
not_for_sale	판매안함 여부
display_group 최소: [1]~최대: [3]	상세 상품분류 1 : 일반상품 2 : 추천상품 3 : 신상품 DEFAULT 1
sequence 최소: [1]~최대: [999998]	진열 순서

Retrieve a list of products by category

GET /api/v2/admin/categories/{category_no}/products

GET

특정 카테고리에 배정된 상품을 목록으로 조회할 수 있습니다.
상품은 동시에 여러 카테고리에 배정될 수 있습니다.
상품번호, 표시 순서, 판매 여부 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
category_no Required	분류 번호
display_group Required 최소: [1]~최대: [3]	상세 상품분류 1 : 일반상품 2 : 추천상품 3 : 신상품
limit 최소: [1]~최대: [50000]	조회결과 최대건수 DEFAULT 50000

Request Copy

Response Copy

Retrieve a count of products by category

GET /api/v2/admin/categories/{category_no}/products/count

GET

특정 카테고리에 배정된 상품의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

category_no
Required

분류 번호

display_group
Required

최소: [1]~최대: [3]

상세 상품분류

1 : 일반상품
2 : 추천상품
3 : 신상품

Request Copy

Response Copy

Add products to a category

POST /api/v2/admin/categories/{category_no}/products

POST

특정 카테고리에 상품을 배정할 수 있습니다.
상품은 동시에 여러 카테고리에 배정될 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

category_no
Required

분류 번호

display_group

최소: [1]~최대: [3]

상세 상품분류

1 : 일반상품
2 : 추천상품
3 : 신상품

DEFAULT 1

product_no
Required

상품번호

Request Copy

Response Copy

Update a product in product category

PUT /api/v2/admin/categories/{category_no}/products

PUT

특정 카테고리에 배정된 상품을 수정할 수 있습니다.
상품 자체를 수정하는 것은 아니며 정렬과 고정 등에 대한 설정값을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
category_no Required	분류 번호
display_group Required 최소: [1]~최대: [3]	상세 상품분류 1 : 일반상품 2 : 추천상품 3 : 신상품
product_no Required	상품번호
sequence 최소: [1]~최대: [999999]	진열 순서
auto_sort	자동 정렬 여부 T : 자동 정렬 사용함 F : 자동 정렬 사용안함
fixed_sort	고정 여부 T : 진열순위 고정 사용함 F : 진열순위 고정 사용안함

Request Copy

Response Copy

Delete a product by category

DELETE /api/v2/admin/categories/{category_no}/products/{product_no}

DELETE

특정 카테고리에 배정된 상품을 삭제할 수 있습니다.
해당 상품은 카테고리에서만 삭제될 뿐이고 실제로 상품 자체가 삭제되는것은 아닙니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

category_no
Required

분류 번호

product_no
Required

상품번호

display_group

최소: [1]~최대: [3]

상세 상품분류

일반상품 영역에서 진열안함 처리 시, 추천상품/신상품 영역에서도 동시에 진열안함 처리된다.

1 : 일반상품
2 : 추천상품
3 : 신상품

DEFAULT 1

Request Copy

Response Copy

Mains products

메인분류 상품(Mains products)은 상품 메인진열의 순서에 관한 메인분류의 관계형 리소스입니다.

Endpoints

GET /api/v2/admin/mains/{display_group}/products
GET /api/v2/admin/mains/{display_group}/products/count
POST /api/v2/admin/mains/{display_group}/products
PUT /api/v2/admin/mains/{display_group}/products
DELETE /api/v2/admin/mains/{display_group}/products/{product_no}

Mains products properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no	상품번호
product_name	상품명
fixed_sort	고정 여부

Retrieve a list of products in main category

GET /api/v2/admin/mains/{display_group}/products

GET

특정 메인분류에 배정된 상품을 목록으로 조회할 수 있습니다.
상품번호, 상품명, 고정 여부 등을 조회할 수 있습니다.
상품은 동시에 여러 메인분류에 배정될 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_group
Required

메인분류 번호

Request Copy

Response Copy

Retrieve a count of products in main category

GET /api/v2/admin/mains/{display_group}/products/count

GET

특정 메인분류에 배정된 상품의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_group
Required

메인분류 번호

Request Copy

Response Copy

Set main category products

POST /api/v2/admin/mains/{display_group}/products

POST

특정 메인분류에 상품을 배정할 수 있습니다.
상품은 동시에 여러 카테고리에 배정될 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shop_no	멀티쇼핑몰 번호 DEFAULT 1
display_group Required	메인분류 번호
product_no Required	상품번호

Request Copy

Response Copy

Update fixed sorting of products in main category

PUT /api/v2/admin/mains/{display_group}/products

PUT

특정 메인분류에 배정된 상품을 수정할 수 있습니다.
상품 자체를 수정하는 것은 아니며 진열순위의 고정 등에 대한 설정값을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shop_no	멀티쇼핑몰 번호 DEFAULT 1
display_group Required	메인분류 번호
product_no Required	상품번호 요청한 상품번호의 순서 대로 진열순위가 지정
fix_product_no	진열순위 고정 상품번호 진열순위를 고정하고자 하는 상품번호를 지정

Request Copy

Response Copy

Delete a product in main category

DELETE /api/v2/admin/mains/{display_group}/products/{product_no}

DELETE

특정 메인분류에 배정된 상품을 삭제할 수 있습니다.
해당 상품은 메인분류에서만 삭제될 뿐이고 실제로 상품 자체가 삭제되는것은 아닙니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_group
Required

메인분류 번호

product_no
Required

상품번호

Request Copy

Response Copy

Products

상품(Products)은 쇼핑몰에서 거래되는 제품의 기본 단위입니다.
컬러, 사이즈 같은 옵션이 있을 경우 각각의 옵션이 상품 하위의 품목으로 생성될 수 있습니다.
상품은 상품명, 공급가, 판매가, 재고정보 등의 정보를 포함하고 있습니다.
상품은 품목, 상품 메모, SEO 등 여러 하위 리소스들을 갖고 있습니다.

Endpoints

GET /api/v2/admin/products
GET /api/v2/admin/products/count
GET /api/v2/admin/products/{product_no}
POST /api/v2/admin/products
PUT /api/v2/admin/products/{product_no}
DELETE /api/v2/admin/products/{product_no}

Products properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
product_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	상품코드 시스템이 상품에 부여한 코드. 해당 쇼핑몰 내에서 상품코드는 중복되지 않음.
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
product_name 최대글자수 : [250자]	상품명 상품의 이름. 상품명은 상품을 구분하는 가장 기초적인 정보이며 검색 정보가 된다. HTML을 사용하여 입력이 가능하다.
eng_product_name 최대글자수 : [250자]	영문 상품명 상품의 영문 이름. 해외 배송 등에 사용 가능함.
supply_product_name 최대글자수 : [250자]	공급사 상품명 공급사에서 등록한 상품의 이름. 공급사에서 상품의 구분을 위해 임의로 입력할 수 있으며 상품명에는 영향을 미치지 않는다.
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명 상품의 모델명.
price_excluding_tax	상품가(세금 제외)
price	상품 판매가 상품의 판매 가격. 쿠폰 및 혜택을 적용하기 전의 가격. 상품 등록시엔 모든 멀티 쇼핑몰에 동일한 가격으로 등록하며, 멀티쇼핑몰별로 다른 가격을 입력하고자 할 경우 상품 수정을 통해 가격을 다르게 입력할 수 있다. ※ 판매가 = [ 공급가 + (공급가 * 마진율) + 추가금액 ]
retail_price	상품 소비자가 시중에 판매되는 소비자 가격. 쇼핑몰의 가격을 강조하기 위한 비교 목적으로 사용함.
supply_price	상품 공급가 상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.
display	진열상태 상품을 쇼핑몰에 진열할지 여부. 상품을 쇼핑몰에 진열할 경우 설정한 상품분류와 메인화면에 표시된다. 상품이 쇼핑몰에 진열되어 있지 않으면 쇼핑몰 화면에 표시되지 않아 접근할 수 없으며 상품을 구매할 수 없다. T : 진열함 F : 진열안함
selling	판매상태 상품을 쇼핑몰에 판매할지 여부. 상품을 진열한 상태로 판매를 중지할 경우 상품은 쇼핑몰에 표시되지만 "품절"로 표시되어 상품을 구매할 수 없다. 상품이 "진열안함"일 경우 "판매함" 상태여도 상품에 접근할 수 없기 때문에 구매할 수 없다. T : 판매함 F : 판매안함
product_condition	상품 상태 판매하는 상품의 상태 표시. N : 신상품 B : 반품상품 R : 재고상품 U : 중고상품 E : 전시상품 F : 리퍼상품 S : 스크래치 상품
product_used_month 최대값: [2147483647]	중고상품 사용 개월
summary_description 최대글자수 : [255자]	상품요약설명 상품에 대한 요약 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다. [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 노출되도록 설정 가능하다.
product_tag 배열 최대사이즈: [50]	상품 검색어 검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그)
margin_rate 최소: [-999.99]~최대: [999.99]	마진률 상품의 원가에 더하여 판매가 계산을 위한 마진율. Api에서는 해당 값은 참고용으로만 사용된다. tax_calculation이 A(자동계산)일 경우 null로 반환됨.
tax_calculation	세금 계산 유형 A : 자동 계산 M : 수동 계산
tax_type	과세 구분 해당 상품의 과세 정보. 해당 상품의 부가세 포함 유형. 과세상품 = 세금이 부과된 상품. 면세상품 = 세금이 면제되는 상품. 가공되지 않은 농/수/축산물, 연탄, 도서류, 보험, 여성용품 등의 상품이 이에 해당하며, 과세사업자로 등록해야 함 영세상품 = 부가세가 0%로 적용되는 수출용 외화 획득 상품 tax_calculation이 A(자동계산)이면서, C(영세상품) 일 경우 'A(과세상품)'으로 반환. A : 과세상품 B : 면세 상품 C : 영세상품
tax_rate 최소: [0]~최대: [100]	과세율
price_content 최대글자수 : [20자]	판매가 대체문구 상품의 가격 대신 표시되는 문구. 품절이나 상품이 일시적으로 판매 불가할 때 사용.
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함
buy_limit_type	구매제한 해당 상품을 구매할 수 있는 회원 정보 표시. N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함 O : 지정된 회원만 구매하며 구매버튼 감추기 D : 지정된 회원만 구매하며 구매버튼 보이기
buy_group_list	구매가능 회원 등급
buy_member_id_list	구매가능 회원아이디
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함
buy_unit_type	구매단위 타입 해당 상품의 구매 단위를 1개 이상으로 설정한 경우 해당 구매 단위를 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준
buy_unit	구매단위 구매할 수 있는 최소한의 단위 표시. 예) 구매 주문단위가 세 개일 경우, 3개, 6개, 9개 단위로 구매 가능함.
order_quantity_limit_type	주문수량 제한 기준 해당 상품의 주문 수량 제한시 제한 기준을 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준
minimum_quantity 최대값: [2147483647]	최소 주문수량 주문 가능한 최소한의 주문 수량. 주문 수량 미만으로 구매 할 수 없음.
maximum_quantity 최대값: [2147483647]	최대 주문수량 주문 가능한 최대한의 주문 수량. 주문 수량을 초과하여 구매 할 수 없음. 최대 주문수량이 "제한없음"일 경우 "0"으로 표시된다.
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함
product_volume	상품 부피 정보
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. T : 사용함 F : 사용안함
detail_image	상세이미지 상품 상세 화면에 표시되는 상품 이미지.
list_image	목록이미지 상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.
tiny_image	작은목록이미지 최근 본 상품 영역에 표시되는 상품의 목록 이미지.
small_image	축소이미지 상품 상세 화면 하단에 표시되는 상품 목록 이미지.
use_naverpay	네이버페이 사용여부 T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
manufacturer_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드 제조사를 등록하면 자동으로 생성되는 코드로 상품에 특정 제조사를 지정할 때 사용. 미입력시 자체제작(M0000000) 사용
trend_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	트렌드 코드 트렌드를 등록하면 자동으로 생성되는 코드로 상품에 특정 트렌드를 지정할 때 사용. 미입력시 기본트렌드(T0000000) 사용
brand_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드 브랜드를 등록하면 자동으로 생성되는 코드로 상품에 특정 브랜드를 지정할 때 사용. 미입력시 자체브랜드(B0000000) 사용
supplier_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드 공급사를 등록하면 자동으로 생성되는 코드로 상품에 특정 공급사를 지정할 때 사용.
made_date	제조일자 상품을 제조한 제조일자.
release_date	출시일자 상품이 시장에 출시된 일자.
expiration_date 배열 최대사이즈: [2]	유효기간 상품을 정상적으로 사용할 수 있는 기간. 상품권이나 티켓 같은 무형 상품, 식품이나 화장품 같은 유형 상품의 유효기간을 표시. 주로 상품권이나 티켓 같은 무형 상품에 사용되며, 해당 무형 상품의 유효기간을 표시.
origin_classification	원산지 국내/국외/기타 F : 국내 T : 국외 E : 기타
origin_place_no	원산지 번호 원산지 번호를 List all Origin API를 통해 원산지를 조회하여 입력 origin_classification이 F(국내)인 경우, 해외 여부(foreign)가 "F"인 원산지만 입력 가능함. origin_classification이 T(해외)인 경우, 해외 여부(foreign)가 "T"인 원산지만 입력 가능함.
origin_place_value 최대글자수 : [30자]	원산지기타정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보.
made_in_code	원산지 국가코드
icon_show_period	아이콘 노출 기간 상품에 설정한 아이콘이 노출되는 기간.
icon 배열 최대사이즈: [5]	아이콘 상품에 표시되는 아이콘. 상품 판매를 강조하기 위한 목적으로 사용이 가능함.
hscode	HS코드 해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함. ※ HS코드 : 세계무역기구(WTO) 및 세계관세기구(WCO)가 무역통계 및 관세분류의 목적상 수출입 상품을 숫자 코드로 분류화 한 것으로, 수입 시 세금부과와 수출품의 통제 및 통계를 위한 분류법
product_weight	상품 중량 상품의 전체 중량(kg). 배송을 위해 상품 자체의 무게와 박스 무게, 포장무게를 모두 포함한 중량 기재가 필요하다.
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
created_date	생성일 상품이 생성된 일시.
updated_date	수정일 상품이 수정된 일시.
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
list_icon	추천 / 품절 / 신상품 아이콘 노출 여부 추천, 품절, 신상품 아이콘을 목록에서 표시하는지 여부 ※ 품절 아이콘 ● 상품이 품절 상태임을 알려주는 아이콘 ● 재고관리 및 품절 기능을 사용하는 상품에 대해 재고가 없을 경우 표시 ※ 추천, 신상품 아이콘 ● 상품분류나 메인화면의 추천상품, 신상품 영역에 진열된 상품인 경우, 설정에 따라 해당 아이콘을 표시함 ※ 아이콘 노출 여부 설정위치 : [쇼핑몰 설정 > 상품 설정 > '상품 정책 설정 > 상품 관련 설정 > 상품 아이콘 설정']
approve_status	승인요청 결과 N : 승인요청 (신규상품) E : 승인요청 (상품수정) C : 승인완료 R : 승인거절 I : 검수진행중 Empty Value : 요청된적 없음
classification_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	자체분류 코드 자체분류를 등록하면 자동으로 생성되는 코드로 상품에 특정 자체분류를 지정할 때 사용. 미입력시 기본자체분류(C000000A) 사용
sold_out	품절여부 T : 품절 F : 품절아님
additional_price	판매가 추가금액
discountprice	상품 할인판매가 리소스
decorationimages	꾸미기 이미지 리소스
benefits	혜택 리소스
options	상품 옵션 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
variants	품목 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
clearance_category_eng	해외통관용 상품구분 영문명 해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 국문명 입력시 입력한 구분명이 자동으로 번역된 항목. 번역된 영문명이 해외송장 상품명에 포함되어 전송됨.
clearance_category_kor	해외통관용 상품구분 국문명 해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 자동으로 영문으로 번역되어 해외송장 상품명 정보에 포함하여 전송.
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드 clearance_category_code
additionalimages	추가 이미지 리소스
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시
exposure_group_list	표시대상 회원 등급
set_product_type	세트상품 타입 C : 일반세트 S : 분리세트
use_kakaopay	카카오페이 사용여부 T : 사용함 F : 사용안함
shipping_fee_by_product	개별배송여부 상품에 배송비를 개별적으로 부과할 것인지 공통 배송비를 부과할 것인지에 대한 설정. 개별 배송비를 사용하지 않을 경우 공통 배송비를 사용함. shipping_calculation이 A(자동계산)일 경우 null로 반환. T : 사용함 F : 사용안함
shipping_fee_type	배송비 타입 (개별배송비를 사용할 경우) 상품의 배송비 타입. shipping_calculation이 A(자동계산)일 경우 null로 반환. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
channeldiscountprices	상품 할인판매가 리소스
market_sync	마켓 연동 여부 T : 사용함 F : 사용안함
memos	메모 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
hits	상품 조회수 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
seo	상품 Seo 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
category	분류 번호 해당 상품이 진열되어있는 상품 분류.
project_no	기획전 번호
description	상품상세설명 상품에 보다 상세한 정보가 포함되어있는 설명. HTML을 사용하여 입력이 가능하다.
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
separated_mobile_description	모바일 별도 등록 T : 직접등록 F : 상품 상세설명 동일
translated_description	상품상세설명 번역정보
payment_info	상품결제안내 상품의 결제 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
shipping_info	상품배송안내 상품의 배송 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
exchange_info	교환/반품안내 상품의 교환/반품 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
service_info	서비스문의/안내 제품의 사후 고객 서비스 방법 대한 안내 문구. HTML을 사용하여 입력이 가능하다.
product_tax_type_text	부가세 표시 문구 [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정 > 추가설정 > 판매가 부가세 표시문구']에서 설정한 문구 표시 tax_calculation이 A(자동계산)일 경우 null로 반환됨.
country_hscode	국가별 HS 코드 해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함. 국가별로 HS 코드의 표준이 다르기 때문에 해당 국가에 맞는 코드 입력이 필요함.
simple_description	상품 간략 설명 상품에 대한 간략한 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다. [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 노출되도록 설정 가능하다.
tags	상품 태그 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
has_option	옵션 사용여부 해당 상품이 옵션을 갖고 있는지에 대한 여부. 옵션을 갖고 있는 상품은 사이즈나 색상과 같은 다양한 선택지를 제공한다. T : 옵션사용함 F : 옵션 사용안함
option_type	옵션 구성방식 옵션을 사용할 경우, 옵션의 유형 표시 ● 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨 ● 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음 ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음. ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨. C : 조합 일체선택형 S : 조합 분리선택형 E : 상품 연동형 F : 독립 선택형
shipping_calculation	배송 계산 유형 A : 자동 계산 M : 수동 계산
shipping_method	배송방법 (개별배송비를 사용할 경우) 배송 수단 및 방법 shipping_calculation이 A(자동계산)일 경우 null로 반환. 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음
prepaid_shipping_fee	배송비 선결제 설정 shipping_calculation이 A(자동계산)일 경우 null로 반환. C : 착불 P : 선결제 B : 선결제/착불
shipping_period	배송기간 (개별배송비를 사용할 경우) 상품 배송시 평균적으로 소요되는 배송 기간. shipping_calculation이 A(자동계산)일 경우 null로 반환.
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별배송료 설정이 사용안함인 경우 설정 불가. shipping_calculation이 A(자동계산)일 경우 null로 반환. A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_area 최대글자수 : [255자]	배송지역 (개별배송비를 사용할 경우) 상품을 배송할 수 있는 지역. shipping_calculation이 A(자동계산)일 경우 null로 반환.
shipping_rates	구간별 배송비 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비 shipping_calculation이 A(자동계산)일 경우 null로 반환.
origin_place_code	원산지 코드 상품의 원산지 코드.
additional_information	추가항목 [쇼핑몰 설정 > 상품 설정 > '상품 보기 설정 > 상품 정보 표시 설정']에서 추가한 추가항목. 기본적인 상품 정보 외에 추가로 표시항 항목이 있을 때 추가하여 사용함.
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.
select_one_by_option	옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 F : 사용안함
translated_additional_description	상품 추가설명 번역정보
additional_image 배열 최대사이즈: [20]	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 특정 상품 상세 조회 API에서만 확인 가능하다.

Retrieve a list of products

GET /api/v2/admin/products

GET

쇼핑몰에 생성되어 있는 상품을 목록으로 조회할 수 있습니다.
상품코드, 상품명, 판매가 등을 조회할 수 있습니다.
상품이 5,000개가 넘을 경우에는 offset 으로는 조회할 수 없으므로 since_product_no 파라메터를 활용해주시면 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
channeldiscountprices embed	상품 할인판매가 리소스
discountprice embed	상품 할인판매가 리소스
decorationimages embed	꾸미기 이미지 리소스
benefits embed	혜택 리소스
options embed	상품 옵션 리소스
variants embed	품목 리소스 상품당 품목정보를 100개까지 조회할 수 있음. 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
additionalimages embed	추가 이미지 리소스
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no	상품번호 조회하고자 하는 상품의 번호 ,(콤마)로 여러 건을 검색할 수 있다.
display	진열상태 진열 혹은 미진열 되어있는 상품 검색.
selling	판매상태 판매중이거나 판매안함 상태의 상품 검색.
product_name	상품명 검색어를 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
product_code	상품코드 검색어를 상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요) ,(콤마)로 여러 건을 검색할 수 있다.
brand_code	브랜드 코드 브랜드 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
manufacturer_code	제조사 코드 제조사 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
supplier_code	공급사 코드 공급사 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
trend_code	트렌드 코드 트렌드 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
product_tag	상품 검색어 검색어를 상품 검색어 또는 태그에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
custom_product_code	자체상품 코드 검색어를 자체상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요) ,(콤마)로 여러 건을 검색할 수 있다.
custom_variant_code	자체 품목 코드 ,(콤마)로 여러 건을 검색할 수 있다.
price_min	상품 판매가 검색 최소값 판매가가 해당 범위 이상인 상품 검색
price_max	상품 판매가 검색 최대값 판매가가 해당 범위 이하인 상품 검색
retail_price_min 최소값: [0] 최대값: [2147483647]	상품 소비자가 검색 최소값 소비자가가 해당 범위 이상인 상품 검색
retail_price_max 최소값: [0] 최대값: [2147483647]	상품 소비자가 검색 최대값 소비자가가 해당 범위 이하인 상품 검색
supply_price_min	상품 공급가 검색 최소값 공급가가 해당 범위 이하인 상품 검색
supply_price_max	상품 공급가 검색 최대값 공급가가 해당 범위 이상인 상품 검색
created_start_date	상품 등록일 검색 시작일 상품 등록일이 해당 날짜 이후인 상품 검색. 등록일 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
created_end_date	상품 등록일 검색 종료일 상품 등록일이 해당 날짜 이전인 상품 검색. 등록일 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
updated_start_date	상품 수정일 검색 시작일 상품 수정일이 해당 날짜 이후인 상품 검색. 수정일 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
updated_end_date	상품 수정일 검색 종료일 상품 수정일이 해당 날짜 이전인 상품 검색. 수정일 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
category	분류 번호 특정 분류에 진열된 상품 검색.
eng_product_name	영문 상품명 검색어를 영문 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
supply_product_name	공급사 상품명 검색어를 공급사 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
internal_product_name	상품명(관리용) ,(콤마)로 여러 건을 검색할 수 있다.
model_name	모델명 검색어를 모델명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
product_condition	상품 상태 특정 상품 상태 검색 ,(콤마)로 여러 건을 검색할 수 있다.
origin_place_value	원산지정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보. ,(콤마)로 여러 건을 검색할 수 있다.
stock_quantity_max	재고수량 검색 최대값 재고가 해당 값 이하로 남아있는 상품 검색. 품목을 여러개 갖고 있는 상품의 경우 해당 조건에 해당하는 품목이 하나라도 있을 경우 검색함.
stock_quantity_min	재고수량 검색 최소값 재고가 해당 값 이상 남아있는 상품 검색. 품목을 여러개 갖고 있는 상품의 경우 해당 조건에 해당하는 품목이 하나라도 있을 경우 검색함.
stock_safety_max	안전재고수량 검색 최대값
stock_safety_min	안전재고수량 검색 최소값
product_weight	상품 중량 해당 중량의 상품 검색. ,(콤마)로 여러 건을 검색할 수 있다.
classification_code	자체분류 ,(콤마)로 여러 건을 검색할 수 있다.
use_inventory	재고 사용여부 해당 상품 품목이 재고를 사용하고 있는지 여부 T : 사용함 F : 사용안함
category_unapplied	미적용 분류 검색 분류가 등록되지 않은 상품에 대하여 검색함. T: 미적용 분류 검색
include_sub_category	하위분류 포함 검색 하위분류에 등록된 상품을 포함하여 검색함. T: 포함
additional_information_key	추가항목 검색조건 키 추가항목에 대하여 검색하기 위한 키. 검색을 위해선 key 와 value 모두 필요함.
additional_information_value	추가항목 검색조건 값 추가항목에 대하여 검색하기 위한 키의 값. 검색을 위해선 key 와 value 모두 필요함.
approve_status	승인상태 검색 N : 승인요청 (신규상품) 상태값 E : 승인요청 (상품수정) 상태값 C : 승인완료 상태값 R : 승인거절 상태값 I : 검수진행중 상태값
since_product_no 최소값: [0] 최대값: [2147483647]	해당 상품번호 이후 검색 특정 상품번호 이후의 상품들을 검색. 해당 검색조건 사용시 offset과 관계 없이 모든 상품을 검색할 수 있다. ※ 해당 검색 조건 사용시 다음 파라메터로는 사용할 수 없다. product_no sort order offset
product_bundle	세트상품 여부 T : 사용함 F : 사용안함
option_type	옵션 구성방식 ,(콤마)로 여러 건을 검색할 수 있다. C : 조합 일체선택형 S : 조합 분리선택형 E : 상품 연동형 F : 독립 선택형
market_sync	마켓 연동 여부 T : 사용함 F : 사용안함
sort	정렬 순서 값 created_date : 등록일 updated_date : 수정일 product_name : 상품명
order	정렬 순서 asc : 순차정렬 desc : 역순 정렬
offset 최대값: [5000]	조회결과 시작위치 조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Request Copy

Response Copy

Retrieve a count of products

GET /api/v2/admin/products/count

GET

쇼핑몰에 등록된 전체 상품의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no	상품번호 조회하고자 하는 상품의 번호 ,(콤마)로 여러 건을 검색할 수 있다.
display	진열상태 진열 혹은 미진열 되어있는 상품 검색.
selling	판매상태 판매중이거나 판매안함 상태의 상품 검색.
product_name	상품명 검색어를 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
product_code	상품코드 상품 코드 ,(콤마)로 여러 건을 검색할 수 있다.
brand_code	브랜드 코드 브랜드 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
manufacturer_code	제조사 코드 제조사 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
supplier_code	공급사 코드 공급사 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
trend_code	트렌드 코드 트렌드 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
product_tag	상품 검색어 검색어를 상품 검색어 또는 태그에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
custom_product_code	자체상품 코드 검색어를 자체상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요) ,(콤마)로 여러 건을 검색할 수 있다.
custom_variant_code	자체 품목 코드 ,(콤마)로 여러 건을 검색할 수 있다.
price_min	상품 판매가 검색 최소값 판매가가 해당 범위 이상인 상품 검색
price_max	상품 판매가 검색 최대값 판매가가 해당 범위 이하인 상품 검색
retail_price_min 최소값: [0] 최대값: [2147483647]	상품 소비자가 검색 최소값 소비자가가 해당 범위 이상인 상품 검색
retail_price_max 최소값: [0] 최대값: [2147483647]	상품 소비자가 검색 최대값 소비자가가 해당 범위 이하인 상품 검색
supply_price_min	상품 공급가 검색 최소값 공급가가 해당 범위 이하인 상품 검색
supply_price_max	상품 공급가 검색 최대값 공급가가 해당 범위 이상인 상품 검색
created_start_date	상품 등록일 검색 시작일 상품 등록일이 해당 날짜 이후인 상품 검색. 등록일 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
created_end_date	상품 등록일 검색 종료일 상품 등록일이 해당 날짜 이전인 상품 검색. 등록일 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
updated_start_date	상품 수정일 검색 시작일 상품 수정일이 해당 날짜 이후인 상품 검색. 수정일 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
updated_end_date	상품 수정일 검색 종료일 상품 수정일이 해당 날짜 이전인 상품 검색. 수정일 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색.
category	분류 번호 특정 분류에 진열된 상품 검색.
eng_product_name	영문 상품명 검색어를 영문 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
supply_product_name	공급사 상품명 검색어를 공급사 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
internal_product_name	상품명(관리용) ,(콤마)로 여러 건을 검색할 수 있다.
model_name	모델명 검색어를 모델명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
product_condition	상품 상태 특정 상품 상태 검색 ,(콤마)로 여러 건을 검색할 수 있다.
origin_place_value	원산지정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보. ,(콤마)로 여러 건을 검색할 수 있다.
stock_quantity_max	재고수량 검색 최대값 재고가 해당 값 이하로 남아있는 상품 검색. 품목을 여러개 갖고 있는 상품의 경우 해당 조건에 해당하는 품목이 하나라도 있을 경우 검색함.
stock_quantity_min	재고수량 검색 최소값 재고가 해당 값 이상 남아있는 상품 검색. 품목을 여러개 갖고 있는 상품의 경우 해당 조건에 해당하는 품목이 하나라도 있을 경우 검색함.
stock_safety_max	안전재고수량 검색 최대값
stock_safety_min	안전재고수량 검색 최소값
product_weight	상품 중량 해당 중량의 상품 검색. ,(콤마)로 여러 건을 검색할 수 있다.
classification_code	자체분류 자체분류 코드가 일치하는 상품 검색 ,(콤마)로 여러 건을 검색할 수 있다.
use_inventory	재고 사용여부 해당 상품 품목이 재고를 사용하고 있는지 여부 T : 사용함 F : 사용안함
category_unapplied	미적용 분류 검색 분류가 등록되지 않은 상품에 대하여 검색함. T: 미적용 분류 검색
include_sub_category	하위분류 포함 검색 하위분류에 등록된 상품을 포함하여 검색함. T: 포함
additional_information_key	추가항목 검색조건 키 추가항목에 대하여 검색하기 위한 키. 검색을 위해선 key 와 value 모두 필요함.
additional_information_value	추가항목 검색조건 값 추가항목에 대하여 검색하기 위한 키의 값. 검색을 위해선 key 와 value 모두 필요함.
approve_status	승인상태 검색 N : 승인요청 (신규상품) 상태값 E : 승인요청 (상품수정) 상태값 C : 승인완료 상태값 R : 승인거절 상태값 I : 검수진행중 상태값
since_product_no 최소값: [0] 최대값: [2147483647]	해당 상품번호 이후 검색 특정 상품번호 이후의 상품들을 검색. 해당 검색조건 사용시 offset과 관계 없이 모든 상품을 검색할 수 있다. ※ 해당 검색 조건 사용시 다음 파라메터로는 사용할 수 없다. product_no sort order offset
product_bundle	세트상품 여부 T : 사용함 F : 사용안함
option_type	옵션 구성방식 ,(콤마)로 여러 건을 검색할 수 있다. C : 조합 일체선택형 S : 조합 분리선택형 E : 상품 연동형 F : 독립 선택형
market_sync	마켓 연동 여부 T : 사용함 F : 사용안함

Request Copy

Response Copy

Retrieve a product resource

GET /api/v2/admin/products/{product_no}

GET

쇼핑몰에 생성되어 있는 상품을 조회할 수 있습니다.
상품코드, 자체상품 코드, 상품명, 상품 판매가 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 조회하고자 하는 상품의 번호
variants embed	품목 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
memos embed	메모 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
hits embed	상품 조회수 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
seo embed	상품 Seo 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
tags embed	상품 태그 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
options embed	상품 옵션 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
discountprice embed	상품 할인판매가 리소스
decorationimages embed	꾸미기 이미지 리소스
benefits embed	혜택 리소스
additionalimages embed	추가 이미지 리소스

Request Copy

Response Copy

Create a product

POST /api/v2/admin/products

POST

쇼핑몰에 상품을 등록할 수 있습니다.
상품을 등록하면서 옵션도 같이 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
display	진열상태 T : 진열함 F : 진열안함 DEFAULT F
selling	판매상태 T : 판매함 F : 판매안함 DEFAULT F
product_condition	상품 상태 N : 신상품 B : 반품상품 R : 재고상품 U : 중고상품 E : 전시상품 F : 리퍼상품 S : 스크래치 상품 DEFAULT N
product_used_month 최대값: [2147483647]	중고상품 사용 개월 상품 상태(product_condition)가 중고 상품일 경우 중고 상품의 사용 개월 수
add_category_no	추가 분류 번호 분류 번호를 사용하여 진열을 원하는 카테고리에 상품 등록
category_no Required 분류 번호 recommend 추천상품 분류 등록 여부 T : 추천상품 등록 F : 추천상품 등록안함 DEFAULT F new 신상품 분류 등록 여부 T : 신상품 등록 F : 신상품 등록안함 DEFAULT F
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
product_name Required 최대글자수 : [250자]	상품명
eng_product_name 최대글자수 : [250자]	영문 상품명
supply_product_name 최대글자수 : [250자]	공급사 상품명
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명
price_excluding_tax 최소: [0]~최대: [2147483647]	상품가(세금 제외) 상품설정조회 상품설정조회 Docs 바로가기 에서 "판매가 계산 기준(calculate_price_based_on)"이 "B(상품가)"일 경우 "price" 대신 필수 입력 필요.
price 최소: [0]~최대: [2147483647]	상품 판매가 필수 입력 단, 상품설정조회 상품설정조회 Docs 바로가기 에서 "판매가 계산 기준(calculate_price_based_on)"이 "B(상품가)"일 경우 "price_excludig_tax"를 사용해야함.
retail_price 최소: [0]~최대: [2147483647]	상품 소비자가
supply_price Required 최소: [0]~최대: [2147483647]	상품 공급가 상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.
has_option	옵션 사용여부 T : 옵션사용함 F : 옵션 사용안함 DEFAULT F
options	옵션
name Required 옵션명 value Required 옵션값
use_naverpay	네이버페이 사용여부 EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
manufacturer_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드 DEFAULT M0000000
trend_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	트렌드 코드 DEFAULT T0000000
brand_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드 DEFAULT B0000000
supplier_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드 DEFAULT S0000000
product_weight 최소: [0]~최대: [999999.99]	상품 중량
made_date	제조일자
release_date	출시일자
expiration_date 배열 최대사이즈: [2]	유효기간
start_date 유효기간 시작일 end_date 유효기간 종료일
description	상품상세설명
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
summary_description 최대글자수 : [255자]	상품요약설명
simple_description	상품 간략 설명
translated_description	상품상세설명 번역정보
product_tag 배열 최대사이즈: [50]	상품 검색어
payment_info	상품결제안내
shipping_info	상품배송안내
exchange_info	교환/반품안내
service_info	서비스문의/안내
icon 배열 최대사이즈: [5]	아이콘
hscode 최대글자수 : [20자]	HS코드 배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력 shipping_calculation이 A(자동계산)일 경우 필수 입력 아님
country_hscode 배열 최대사이즈: [29]	국가별 HS 코드
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별배송료 설정이 사용안함인 경우 설정 불가. ※ 쇼핑몰이 EC Global 쇼핑몰일 경우 "C"를 필수로 입력해야한다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_method	배송방법 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음
shipping_fee_by_product	개별배송여부 T : 개별배송 F : 기본배송 DEFAULT F
shipping_area 최대글자수 : [255자]	배송지역
shipping_period 배열 최대사이즈: [2]	배송기간
minimum 최소 기간 DEFAULT 1 maximum 최대 기간 DEFAULT 7
shipping_fee_type	배송비 타입 개별배송비를 사용할 경우 상품의 배송비 타입. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_rates 배열 최대사이즈: [200]	배송비 금액 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비
shipping_rates_min 배송비 구간 시작 기준 shipping_rates_max 배송비 구간 종료 기준 shipping_fee 배송비
prepaid_shipping_fee	배송비 선결제 설정 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 착불 P : 선결제 B : 선결제/착불
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드 배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력 shipping_calculation이 A(자동계산)일 경우 필수 입력 아님 clearance_category_code
detail_image	상세이미지
list_image	목록이미지
tiny_image	작은목록이미지
small_image	축소이미지
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록 DEFAULT A
additional_information	추가항목
key Required 추가항목 키 value 추가항목 값
price_content 최대글자수 : [20자]	판매가 대체문구
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함 DEFAULT F
buy_limit_type	구매제한 N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함 O : 지정된 회원만 구매하며 구매버튼 감추기 D : 지정된 회원만 구매하며 구매버튼 보이기 DEFAULT F
buy_group_list	구매가능 회원 등급
buy_member_id_list	구매가능 회원아이디
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함 DEFAULT F
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함 DEFAULT F
buy_unit_type	구매단위 타입 해당 상품의 구매 단위를 1개 이상으로 설정한 경우 해당 구매 단위를 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준 DEFAULT O
buy_unit 최대값: [2147483647]	구매단위 DEFAULT 1
order_quantity_limit_type	주문수량 제한 기준 해당 상품의 주문 수량 제한시 제한 기준을 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준 DEFAULT O
minimum_quantity 최대값: [2147483647]	최소 주문수량 주문 가능한 최소한의 주문 수량. 주문 수량 미만으로 구매 할 수 없음. DEFAULT 1
maximum_quantity 최대값: [2147483647]	최대 주문수량 주문 가능한 최대한의 주문 수량. 주문 수량을 초과하여 구매 할 수 없음. 최대 주문수량을 "제한없음"으로 입력하려면 0을 입력 DEFAULT 0
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정 DEFAULT F
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
payment_method 적립금 결제방법 naverpay : 네이버페이 smilepay : 스마일페이 kakaopay : 카카오페이 payco : 페이코 paynow : 페이나우 kpay : 케이페이 icash : 가상계좌 결제 deposit : 예치금 결제 tcash : 실시간 계좌이체 cell : 휴대폰 결제 card : 카드 결제 mileage : 적립금 결제 cash : 무통장 입금 points_rate 적립율 points_unit_by_payment 결제방법별 적립금 단위 P : 퍼센트 단위 W : 원단위
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함 DEFAULT F
product_volume	상품 부피 정보
use_product_volume 상품부피 사용여부 product_width 가로 product_height 세로 product_length 높이
origin_classification	원산지 국내/국외/기타 F : 국내 T : 국외 E : 기타
origin_place_no	원산지 번호 원산지 번호를 Retrieve a list of origins API를 통해 원산지를 조회하여 입력 origin_classification이 F(국내)인 경우, 해외 여부(foreign)가 "F"인 원산지만 입력 가능함. origin_classification이 T(해외)인 경우, 해외 여부(foreign)가 "T"인 원산지만 입력 가능함.
origin_place_value 최대글자수 : [30자]	원산지기타정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보.
made_in_code	원산지 국가코드 원산지 국가를 두자리 국가코드로 입력 원산지를 국가 단위로만 입력하는 경우 원산지 번호(origin_place_no)와 원산지 구분(origin_classification) 대신 사용 가능하다.
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.
product_no Required 상품번호 interrelated Required 관련상품 상호등록 여부 T : 상호등록 F : 일방등록
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
classification_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	자체분류
additional_price 최대값: [2147483647]	판매가 추가금액 판매가 계산시 상품의 원가와 마진율에 더하여 추가로 계산되는 금액. API에서 해당 금액은 참고 목적으로만 사용된다.
margin_rate 최소: [-999.99]~최대: [999.99]	마진률 상품의 원가에 더하여 판매가 계산을 위한 마진율. Api에서는 해당 값은 참고용으로만 사용된다.
tax_type	과세 구분 해당 상품의 과세 정보. 해당 상품의 부가세 포함 유형. 과세상품 = 세금이 부과된 상품. 면세상품 = 세금이 면제되는 상품. 가공되지 않은 농/수/축산물, 연탄, 도서류, 보험, 여성용품 등의 상품이 이에 해당하며, 과세사업자로 등록해야 함 영세상품 = 부가세가 0%로 적용되는 수출용 외화 획득 상품 A : 과세상품 B : 면세 상품 C : 영세상품
tax_rate 최소: [0]~최대: [100]	과세율
additional_image	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 추가이미지는 최대 20개까지 등록 가능하다.
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. [쇼핑몰 설정 > 고객 설정 > '회원 정책 설정 > 회원 관련 설정 > 회원가입 및 본인인증 설정'] 에서 성인인증 사용 시 구매차단 설정이 사용함이어야 성인인증이 적용된다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함 DEFAULT F
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시 DEFAULT A
exposure_group_list	표시대상 회원 등급
use_kakaopay	카카오페이 사용여부 EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함

Request Copy

Response Copy

Update a product

PUT /api/v2/admin/products/{product_no}

PUT

쇼핑몰에 생성되어 있는 상품을 수정할 수 있습니다.
진열상태, 판매상태, 상품명 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
display	진열상태 상품을 쇼핑몰에 진열할지 여부 변경. T : 진열함 F : 진열안함
selling	판매상태 T : 판매함 F : 판매안함
product_condition	상품 상태 N : 신상품 B : 반품상품 R : 재고상품 U : 중고상품 E : 전시상품 F : 리퍼상품 S : 스크래치 상품
product_used_month 최대값: [2147483647]	중고상품 사용 개월 상품 상태(product_condition)가 중고 상품일 경우 중고 상품의 사용 개월 수
add_category_no	추가 분류 번호 상품분류 번호를 입력하여 해당 상품에 특정 상품분류를 추가 등록
category_no Required 분류 번호 recommend 추천상품 분류 등록 여부 T : 추천상품 등록 F : 추천상품 등록안함 DEFAULT F new 신상품 분류 등록 여부 T : 신상품 등록 F : 신상품 등록안함 DEFAULT F
delete_category_no	삭제 분류 번호 상품분류 번호를 입력하여 해당 상품에 특정 상품분류 삭제
custom_product_code 최대글자수 : [40자]	자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.
product_name 최대글자수 : [250자]	상품명
eng_product_name 최대글자수 : [250자]	영문 상품명
supply_product_name 최대글자수 : [250자]	공급사 상품명
internal_product_name 최대글자수 : [50자]	상품명(관리용)
model_name 최대글자수 : [100자]	모델명
price_excluding_tax 최소: [0]~최대: [2147483647]	상품가(세금 제외) 상품설정조회(GET:/products/setting) 에서 "판매가 계산 기준(calculate_price_based_on)"이 "B(상품가)"일 경우 Price가 아니라 price_excluding_tax를 입력해야한다.
price 최소: [0]~최대: [2147483647]	상품 판매가 tax_calculation이 A(자동계산)일 경우, 상품설정조회(GET:/products/setting)의 "판매가 계산 기준(calculate_price_based_on)" 값과 상관없이 price로만 입력해야 한다.
retail_price 최소: [0]~최대: [2147483647]	상품 소비자가
supply_price 최소: [0]~최대: [2147483647]	상품 공급가 상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.
use_naverpay	네이버페이 사용여부 EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
naverpay_type	네이버페이 판매타입 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 네이버페이 + 쇼핑몰 동시판매 상품 O : 네이버페이 전용상품
manufacturer_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드
trend_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	트렌드 코드
brand_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드
supplier_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드
product_weight 최소: [0]~최대: [999999.99]	상품 중량
made_date	제조일자
release_date	출시일자
expiration_date 배열 최대사이즈: [2]	유효기간
start_date 유효기간 시작일 end_date 유효기간 종료일
description	상품상세설명
mobile_description	모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.
translated_description	상품상세설명 번역정보
translated_additional_description	상품 추가설명 번역정보
summary_description 최대글자수 : [255자]	상품요약설명
simple_description	상품 간략 설명
product_tag 배열 최대사이즈: [50]	상품 검색어
payment_info	상품결제안내
shipping_info	상품배송안내
exchange_info	교환/반품안내
service_info	서비스문의/안내
icon 배열 최대사이즈: [5]	아이콘
use_icon_exposure_term	표시기간 사용 여부 T : 사용함 F : 사용안함
icon_exposure_begin_datetime	표시기간 시작 일자
icon_exposure_end_datetime	표시기간 종료 일자
hscode 최대글자수 : [20자]	HS코드 배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력 shipping_calculation이 A(자동계산)일 경우 필수 입력 아님
country_hscode 배열 최대사이즈: [29]	국가별 HS 코드
shipping_scope	배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. [쇼핑몰 설정 > 배송 설정 > '배송 정책 설정 > 배송비 설정 > 개별배송비 설정'] 에서 상품별 개별배송료 설정이 사용안함인 경우 설정 불가. EC 베트남, 필리핀 버전에서는 사용할 수 없음. A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_method	배송방법 01 : 택배 02 : 빠른등기 03 : 일반등기 04 : 직접배송 05 : 퀵배송 06 : 기타 07 : 화물배송 08 : 매장직접수령 09 : 배송필요 없음
shipping_fee_by_product	개별배송여부 T : 개별배송 F : 기본배송
shipping_area 최대글자수 : [255자]	배송지역
shipping_period	배송기간
minimum 최소 기간 DEFAULT 1 maximum 최대 기간 DEFAULT 7
shipping_fee_type	배송비 타입 개별배송비를 사용할 경우 상품의 배송비 타입. T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_rates 배열 최대사이즈: [200]	배송비 금액 개별배송비를 사용할 경우 상품의 개별 배송비. shipping_fee_type이 R, N일 경우 배열 안에 shipping_fee를 정의하여 배송비를 설정할 수 있다. shipping_fee_type이 M, D, W, C일 경우 배열 안에 다음과 같이 정의하여 배송비 구간을 설정할 수 있다. shipping_rates_min : 배송비 구간 시작 기준 shipping_rates_max : 배송비 구간 종료 기준 shipping_fee : 배송비
shipping_rates_min 배송비 구간 시작 기준 shipping_rates_max 배송비 구간 종료 기준 shipping_fee 배송비
prepaid_shipping_fee	배송비 선결제 설정 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 착불 P : 선결제 B : 선결제/착불
clearance_category_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	해외통관코드 배송정보(shipping_scope)가 C(해외배송)일 경우 필수 입력 shipping_calculation이 A(자동계산)일 경우 필수 입력 아님 clearance_category_code
detail_image	상세이미지
list_image	목록이미지
tiny_image	작은목록이미지
small_image	축소이미지
image_upload_type	이미지 업로드 타입 이미지 업로드시 이미지 업로드 타입. "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드 "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드 ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음 A : 대표이미지등록 B : 개별이미지등록 C : 웹FTP 등록
additional_information	추가항목
key Required 추가항목 키 value 추가항목 값
price_content 최대글자수 : [20자]	판매가 대체문구
buy_limit_by_product	구매제한 개별 설정여부 T : 사용함 F : 사용안함
buy_limit_type	구매제한 N : 회원만 구매하며 구매버튼 감추기 M : 회원만 구매하며 구매버튼 보이기 F : 구매제한 안함 O : 지정된 회원만 구매하며 구매버튼 감추기 D : 지정된 회원만 구매하며 구매버튼 보이기
buy_group_list	구매가능 회원 등급
buy_member_id_list	구매가능 회원아이디
repurchase_restriction	재구매 제한 T : 재구매 불가 F : 제한안함
single_purchase_restriction	단독구매 제한 T : 단독구매 불가 F : 제한안함
buy_unit_type	구매단위 타입 해당 상품의 구매 단위를 1개 이상으로 설정한 경우 해당 구매 단위를 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준
buy_unit 최대값: [2147483647]	구매단위
order_quantity_limit_type	주문수량 제한 기준 해당 상품의 주문 수량 제한시 제한 기준을 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 O : 품목 기준
minimum_quantity 최대값: [2147483647]	최소 주문수량
maximum_quantity 최대값: [2147483647]	최대 주문수량 주문 가능한 최대한의 주문 수량. 주문 수량을 초과하여 구매 할 수 없음. 최대 주문수량을 "제한없음"으로 입력하려면 0을 입력 최소주문수량 수정시 최대주문수량을 같이 수정해야한다.
points_by_product	적립금 개별설정 사용여부 F : 기본설정 사용 T : 개별설정
points_setting_by_payment	결제방식별 적립금 설정 여부 B : 기본 적립금설정 사용 C : 결제방식에 따른 적립
points_amount	적립금 설정 정보
payment_method 적립금 결제방법 naverpay : 네이버페이 smilepay : 스마일페이 kakaopay : 카카오페이 payco : 페이코 paynow : 페이나우 kpay : 케이페이 icash : 가상계좌 결제 deposit : 예치금 결제 tcash : 실시간 계좌이체 cell : 휴대폰 결제 card : 카드 결제 mileage : 적립금 결제 cash : 무통장 입금 points_rate 적립율 points_unit_by_payment 결제방법별 적립금 단위 P : 퍼센트 단위 W : 원단위
except_member_points	회원등급 추가 적립 제외 T : 회원등급 추가 적립 제외 설정함 F : 회원등급 추가 적립 제외 설정안함
product_volume	상품 부피 정보
use_product_volume 상품부피 사용여부 product_width 가로 product_height 세로 product_length 높이
origin_classification	원산지 국내/국외/기타 F : 국내 T : 국외 E : 기타
origin_place_no	원산지 번호 원산지 번호를 List all Origin API를 통해 원산지를 조회하여 입력 origin_classification이 F(국내)인 경우, 해외 여부(foreign)가 "F"인 원산지만 입력 가능함. origin_classification이 T(해외)인 경우, 해외 여부(foreign)가 "T"인 원산지만 입력 가능함.
origin_place_value 최대글자수 : [30자]	원산지기타정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보.
made_in_code	원산지 국가코드 원산지 국가를 두자리 국가코드로 입력 원산지를 국가 단위로만 입력하는 경우 원산지 번호(origin_place_no)와 원산지 구분(origin_classification) 대신 사용 가능하다.
main	메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.
relational_product 배열 최대사이즈: [200]	관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.
product_no 상품번호 interrelated Required 관련상품 상호등록 여부 T : 상호등록 F : 일방등록
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
english_product_material	영문 상품 소재 상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음. woven : 직물(woven) knit : 편물(knit)
classification_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	자체분류
additional_price 최대값: [2147483647]	판매가 추가금액 판매가 계산시 상품의 원가와 마진율에 더하여 추가로 계산되는 금액. API에서 해당 금액은 참고 목적으로만 사용된다.
margin_rate 최소: [-999.99]~최대: [999.99]	마진률 상품의 원가에 더하여 판매가 계산을 위한 마진율. Api에서는 해당 값은 참고용으로만 사용된다.
tax_type	과세 구분 해당 상품의 과세 정보. 해당 상품의 부가세 포함 유형. 과세상품 = 세금이 부과된 상품. 면세상품 = 세금이 면제되는 상품. 가공되지 않은 농/수/축산물, 연탄, 도서류, 보험, 여성용품 등의 상품이 이에 해당하며, 과세사업자로 등록해야 함 영세상품 = 부가세가 0%로 적용되는 수출용 외화 획득 상품 A : 과세상품 B : 면세 상품 C : 영세상품
tax_rate 최소: [0]~최대: [100]	과세율
additional_image	추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 추가이미지는 최대 20개까지 등록 가능하다.
adult_certification	성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. [쇼핑몰 설정 > 고객 설정 > '회원 정책 설정 > 회원 관련 설정 > 회원가입 및 본인인증 설정'] 에서 성인인증 사용 시 구매차단 설정이 사용함이어야 성인인증이 적용된다. EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
exposure_limit_type	표시제한 범위 A : 모두에게 표시 M : 회원에게만 표시
exposure_group_list	표시대상 회원 등급
use_kakaopay	카카오페이 사용여부 EC 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함

Request Copy

Response Copy

Delete a product

DELETE /api/v2/admin/products/{product_no}

DELETE

쇼핑몰에 생성되어 있는 상품을 삭제할 수 있습니다.
상품 삭제 시에는 상품 하위에 옵션(품목)도 함께 삭제됩니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Request Copy

Response Copy

Products additionalimages

상품 추가 이미지(Products additionalimages)는 상품의 추가이미지를 나타내는 하위 리소스로, 상품(Products)리소스의 하위에서만 사용할 수 있습니다.

Endpoints

POST /api/v2/admin/products/{product_no}/additionalimages
PUT /api/v2/admin/products/{product_no}/additionalimages
DELETE /api/v2/admin/products/{product_no}/additionalimages

Products additionalimages properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
additional_image	추가이미지
product_no	상품번호

Create an additional product image

POST /api/v2/admin/products/{product_no}/additionalimages

POST

해당 상품의 추가 이미지를 등록할 수 있습니다.
추가 이미지 업로드시 Base64로 인코드하여 업로드할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

additional_image
Required

추가이미지

● 최대요청건수 : 20개
● 이미지 파일 용량 제한 : 5MB
● 한 호출당 이미지 전체 용량 제한 : 30MB

Request Copy

Response Copy

Update an additional product image

PUT /api/v2/admin/products/{product_no}/additionalimages

PUT

해당 상품의 추가 이미지를 수정할 수 있습니다.
추가 이미지 업로드시 Base64로 인코드하여 업로드할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

additional_image
Required

추가이미지

● 최대요청건수 : 20개
● 이미지 파일 용량 제한 : 5MB
● 한 호출당 이미지 전체 용량 제한 : 30MB

Request Copy

Response Copy

Delete an additional product image

DELETE /api/v2/admin/products/{product_no}/additionalimages

DELETE

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

Request Copy

Response Copy

Products approve

상품 승인(Products approve)은 공급사가 업로드한 상품을 검토 후 승인하는 기능입니다.
해당 기능은 일부 쇼핑몰에만 적용된 상태로, 공급사 상품 승인 기능을 사용중인 몰에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/approve
POST /api/v2/admin/products/{product_no}/approve
PUT /api/v2/admin/products/{product_no}/approve

Products approve properties

Attribute

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

status
Required

상태

공급사가 승인 요청한 해당 상품의 승인 상태

N : 승인요청 (신규상품) 상태값
E : 승인요청 (상품수정) 상태값
C : 승인완료 상태값
R : 승인거절 상태값
I : 검수진행중 상태값
Empty Value : 요청된적 없음

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Retrieve a product approval status

GET /api/v2/admin/products/{product_no}/approve

GET

해당 상품의 승인 상태를 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Request Copy

Response Copy

Create a product approval request

POST /api/v2/admin/products/{product_no}/approve

POST

해당 상품에 대한 승인 신청을 할 수 있습니다.
승인신청한 상품은 승인요청(신규상품) 상태로 승인 요청됩니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

user_id
Required

공급사 운영자 아이디

승인 요청한 공급사의 아이디

Request Copy

Response Copy

Update a product approval status

PUT /api/v2/admin/products/{product_no}/approve

PUT

해당 상품의 승인 상태를 변경할 수 있습니다.
대표관리자가 상품을 승인한 경우 승인완료로 업데이트할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
user_id Required	공급사 운영자 아이디 승인 요청한 공급사의 아이디
status Required	상태 공급사가 승인 요청한 해당 상품의 승인 상태 C : 승인완료 상태값 R : 승인거절 상태값 I : 검수진행중 상태값

Request Copy

Response Copy

Products decorationimages

꾸미기 이미지(Decorationimages)는 쇼핑몰에 진열된 상품 이미지 위에 추가하여 상품에 포인트를 줄 수 있는 기능입니다.
쇼핑몰에 등록되어있는 꾸미기 이미지를 조회하여 상품별로 꾸미기 이미지를 지정하거나, 상품에 등록되어있는 꾸미기 이미지를 조회할 수 있습니다.
꾸미기 이미지는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/decorationimages
GET /api/v2/admin/products/{product_no}/decorationimages
POST /api/v2/admin/products/{product_no}/decorationimages
PUT /api/v2/admin/products/{product_no}/decorationimages
DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}

Products decorationimages properties

Attribute	Description
code	꾸미기 이미지 코드
path	꾸미기 이미지 URL
shop_no	멀티쇼핑몰 번호
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date	표시기간 시작 일자
show_end_date	표시기간 종료 일자
image_list	꾸미기 이미지 리스트 수평위치(image_horizontal_position) L : 왼쪽 C : 가운데 R : 오른쪽 수직위치(image_vertical_position) T : 상단 C : 중단 B : 하단

Retrieve a list of decoration images

GET /api/v2/admin/products/decorationimages

GET

쇼핑몰에 등록되어있는 꾸미기 이미지를 목록으로 조회합니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

Request Copy

Response Copy

Retrieve a list of product decoration images

GET /api/v2/admin/products/{product_no}/decorationimages

GET

특정 상품에 등록되어 있는 꾸미기 이미지를 목록으로 조회합니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Request Copy

Response Copy

Set decoration images for a product

POST /api/v2/admin/products/{product_no}/decorationimages

POST

꾸미기 이미지를 상품에 추가할 수 있습니다.
꾸미기 이미지 추가시 표시 기간과 꾸미기 이미지의 위치 등을 설정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date 날짜	표시기간 시작 일자
show_end_date 날짜	표시기간 종료 일자
image_list Required	꾸미기 이미지 리스트 수평위치(image_horizontal_position) L : 왼쪽 C : 가운데 R : 오른쪽 수직위치(image_vertical_position) T : 상단 C : 중단 B : 하단
code 꾸미기 이미지 코드 path 꾸미기 이미지 경로 image_horizontal_position 꾸미기 이미지 수평값 image_vertical_position 꾸미기 이미지 수직값

Request Copy

Response Copy

Update product decoration images

PUT /api/v2/admin/products/{product_no}/decorationimages

PUT

상품번호를 이용하여 해당 상품의 꾸미기 이미지를 수정할 수 있습니다.
표시기간 사용 여부, 표시기간 시작 일자, 종료 일자 등을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date 날짜	표시기간 시작 일자
show_end_date 날짜	표시기간 종료 일자
image_list Required	꾸미기 이미지 리스트 수평위치(image_horizontal_position) L : 왼쪽 C : 가운데 R : 오른쪽 수직위치(image_vertical_position) T : 상단 C : 중단 B : 하단
code 꾸미기 이미지 코드 path 꾸미기 이미지 경로 image_horizontal_position 꾸미기 이미지 수평값 image_vertical_position 꾸미기 이미지 수직값

Request Copy

Response Copy

Remove a product decoration image

DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}

DELETE

상품에 등록된 꾸미기 이미지를 삭제합니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

code
Required

꾸미기 이미지 코드

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Request Copy

Response Copy

Products discountprice

상품 할인가(Discountprice)는 상품의 할인가격을 표시하는 리소스입니다. 혜택(Benefits)이 적용된 상품의 경우 상품의 할인가를 조회할 수 있습니다.
상품 할인가는 하위 리소스로서 상품(Products) 하위에서만 사용가능하며, 상품 목록 조회시 Embed 파라메터로 호출가능합니다.

Endpoints

GET /api/v2/admin/products/{product_no}/discountprice

Products discountprice properties

Attribute	Description
pc_discount_price	PC 할인 판매가
mobile_discount_price	모바일 할인 판매가
app_discount_price	앱 할인 판매가

Retrieve a product discounted price

GET /api/v2/admin/products/{product_no}/discountprice

GET

상품번호를 이용하여 해당 상품의 할인가를 조회합니다.
PC 할인 판매가, 모바일 할인 판매가를 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

Request Copy

Response Copy

Products hits

상품 조회수(Hits)는 상품을 쇼핑몰 고객들이 얼마나 조회했는지를 나타내는 지표입니다.
상품 조회수를 확인하면, 고객들이 어떤 상품을 가장 많이 조회하는지 알 수 있습니다.
상품 조회수는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/hits/count

Retrieve a count of product views

GET /api/v2/admin/products/{product_no}/hits/count

GET

상품번호를 이용하여 해당 상품의 조회수를 조회합니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Request Copy

Response Copy

Products icons

상품 아이콘은 상품을 강조하기 위해 상품 옆에 추가할 수 있는 작은 이미지들입니다. 진열된 상품에 할인 정보, "매진 임박" 등의 메시지를 추가하여 상품을 강조할 수 있습니다.
상품 아이콘는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/icons
GET /api/v2/admin/products/{product_no}/icons
POST /api/v2/admin/products/{product_no}/icons
PUT /api/v2/admin/products/{product_no}/icons
DELETE /api/v2/admin/products/{product_no}/icons/{code}

Products icons properties

Attribute	Description
code	상품 아이콘 코드
path	아이콘 URL
shop_no	멀티쇼핑몰 번호
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date	표시기간 시작 일자
show_end_date	표시기간 종료 일자
image_list	상품 아이콘 리스트

Retrieve a list of icons

GET /api/v2/admin/products/icons

GET

상품에 등록된 모든 아이콘을 조회할 수 있습니다.
현재 특정 상품에 어떤 아이콘들이 등록되어 있는지 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

Request Copy

Response Copy

Retrieve a list of product icons

GET /api/v2/admin/products/{product_no}/icons

GET

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

Request Copy

Response Copy

Set icons for a product

POST /api/v2/admin/products/{product_no}/icons

POST

상품 아이콘을 상품에 등록할 수 있습니다.
아이콘을 상품에 등록하기 전에 우선 List all icons 를 통해 아이콘의 코드를 확인해주세요.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
image_list Required 배열 최대사이즈: [5]	상품 아이콘 리스트
code Required 상품 아이콘 코드

Request Copy

Response Copy

Update product icons

PUT /api/v2/admin/products/{product_no}/icons

PUT

상품에 등록한 상품 아이콘을 수정할 수 있습니다.
아이콘의 표시여부, 표시기간 등을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
use_show_date	표시기간 사용 여부 T : 사용함 F : 사용안함
show_start_date 날짜	표시기간 시작 일자
show_end_date 날짜	표시기간 종료 일자
image_list 배열 최대사이즈: [5]	상품 아이콘 리스트
code Required 상품 아이콘 코드

Request Copy

Response Copy

Remove a product icon

DELETE /api/v2/admin/products/{product_no}/icons/{code}

DELETE

상품에 등록된 상품 아이콘을 삭제(등록해제) 할 수 있습니다.
아이콘 자체는 삭제되지 않으며 상품에 등록된 상태만 해제됩니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

product_no
Required

상품번호

code
Required

상품 아이콘 코드

Request Copy

Response Copy

Products images

상품 이미지(Products Images)는 상품의 판매를 위해서 업로드한 상품의 사진이나 그림을 의미합니다.
상품 이미지 API를 사용해 상품 상세설명에서 사용할 이미지를 업로드하거나, 상품의 이미지를 업로드할 수 있습니다.
상품의 이미지는 Base64 코드 로 인코딩하여 업로드할 수 있습니다

Endpoints

POST /api/v2/admin/products/images
POST /api/v2/admin/products/{product_no}/images
DELETE /api/v2/admin/products/{product_no}/images

Products images properties

Attribute	Description
path	상세이미지
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
detail_image	상세이미지 상품 상세 화면에 표시되는 상품 이미지.
list_image	목록이미지 상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.
tiny_image	작은목록이미지 상품 상세 화면 하단에 표시되는 상품 목록 이미지.
small_image	축소이미지 최근 본 상품 영역에 표시되는 상품의 목록 이미지.

Upload images

POST /api/v2/admin/products/images

POST

이미지를 업로드할 수 있습니다.
상품에 이미지를 등록하기 위해서는 이미지를 먼저 업로드해야 합니다.
상품의 이미지는 Base64 코드 로 인코딩하여 업로드할 수 있습니다

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	20

요청사양

Parameter

Description

image
Required

상세이미지

● 이미지 파일 용량 제한 : 10MB
● 한 호출당 이미지 전체 용량 제한 : 30MB

Request Copy

Response Copy

Upload product images

POST /api/v2/admin/products/{product_no}/images

POST

이미지를 상품에 등록할 수 있습니다.
상품의 상세, 목록, 작은목록, 축소 이미지를 등록할 수 있습니다.
이미지를 등록하기 전에 이미지가 업로드 되어있는지 먼저 확인해주세요.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
detail_image	상세이미지 상품 상세 화면에 표시되는 상품 이미지.
list_image	목록이미지 상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.
tiny_image	작은목록이미지 상품 상세 화면 하단에 표시되는 상품 목록 이미지.
small_image	축소이미지 최근 본 상품 영역에 표시되는 상품의 목록 이미지.
image_upload_type Required	이미지 업로드 타입 이미지 타입이 대표 이미지 인지, 개별 이미지 인지 업로드 타입을 지정할 수 있음. 대표 이미지(A)로 업로드 하는 경우 상세이미지(detail_image)에 이미지를 업로드하면 다른 나머지 이미지에도 모두 반영됨. A : 대표이미지등록 B : 개별이미지등록

Request Copy

Response Copy

Delete product images

DELETE /api/v2/admin/products/{product_no}/images

DELETE

상품에 등록된 이미지를 삭제할 수 있습니다.
상세이미지나 목록이미지 등의 구분 없이 상품에 등록된 모든 이미지가 삭제됩니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Request Copy

Response Copy

Products memos

상품 메모(Products memos)는 상품에 관한 특이사항을 메모하거나 운영자 간의 의사소통을 위한 도구로 활용할 수 있습니다.
상품 메모는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/memos
GET /api/v2/admin/products/{product_no}/memos/{memo_no}
POST /api/v2/admin/products/{product_no}/memos
PUT /api/v2/admin/products/{product_no}/memos/{memo_no}
DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}

Products memos properties

Attribute	Description
memo_no	메모 번호 시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.
author_id 최대글자수 : [20자]	작성자 아이디 메모를 작성한 관리자의 아이디 정보.
created_date	생성일 메모를 작성한 시간.
memo	메모 메모의 내용. HTML을 사용하여 등록할 수 있다.

Retrieve a list of product memos

GET /api/v2/admin/products/{product_no}/memos

GET

특정 상품에 등록된 메모를 목록으로 조회할 수 있습니다.
작성자 아이디, 생성일, 메모 내용 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

offset

최대값: [8000]

조회결과 시작위치

DEFAULT 0

limit

최소: [1]~최대: [100]

조회결과 최대건수

조회하고자 하는 최대 건수를 지정할 수 있음.
예) 10 입력시 10건만 표시함.

DEFAULT 10

Request Copy

Response Copy

Retrieve a product memo

GET /api/v2/admin/products/{product_no}/memos/{memo_no}

GET

특정 상품에 등록된 메모 1개를 조회할 수 있습니다.
작성자 아이디, 생성일, 메모내용 등을 조회할 수 있습니다.
메모를 조회하기 위해선 메모번호가 필요합니다. 메모번호는 List all products memos 를 통해 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

memo_no
Required

메모 번호

시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.

Request Copy

Response Copy

Create a product memo

POST /api/v2/admin/products/{product_no}/memos

POST

특정 상품에 대한 메모를 등록할 수 있습니다.
메모를 등록할 때에는 메모 작성자의 아이디를 입력해야 합니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

author_id
Required

최대글자수 : [20자]

작성자 아이디

메모를 작성한 관리자의 아이디 정보.

memo
Required

메모

메모의 내용. HTML을 사용하여 등록할 수 있다.

Request Copy

Response Copy

Update a product memo

PUT /api/v2/admin/products/{product_no}/memos/{memo_no}

PUT

특정 상품에 등록된 메모를 수정할 수 있습니다.
메모를 수정할 때에는 메모 작성자의 아이디와 메모번호를 입력해야 합니다.
메모번호는 List all products memos 를 통해 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
memo_no Required	메모 번호 시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.
author_id Required 최대글자수 : [20자]	작성자 아이디 메모를 작성한 관리자의 아이디 정보.
memo Required	메모 메모의 내용. HTML을 사용하여 등록할 수 있다.

Request Copy

Response Copy

Delete a product memo

DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}

DELETE

특정 상품에 등록된 메모를 삭제할 수 있습니다.
메모를 삭제하기 위해선 메모번호가 필요합니다. 메모번호는 List all products memos 를 통해 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

memo_no
Required

메모 번호

시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.

Request Copy

Response Copy

Products options

상품 옵션(Products options)은 상품이 다른 색상이나 사이즈를 갖고 있는 경우 이를 각각의 옵션으로 구현할 수 있도록 하는 기능입니다.
옵션은 색상, 사이즈 같은 옵션명(option_name)과 색상 중 빨간색, 노란색과 같은 옵션값(option_value)으로 구성되어있습니다.
상품에 옵션 등록시 옵션을 기반으로 품목(variants)이 생성됩니다.
옵션은 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.
옵션의 목록조회, 생성, 수정, 삭제가 가능합니다.

Endpoints

GET /api/v2/admin/products/{product_no}/options
POST /api/v2/admin/products/{product_no}/options
PUT /api/v2/admin/products/{product_no}/options
DELETE /api/v2/admin/products/{product_no}/options

Products options properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
has_option	옵션 사용여부 T : 사용함 F : 사용안함
option_type	옵션 구성방식 옵션을 사용할 경우, 옵션의 유형 표시 ● 조합형 : 옵션명을 기준으로 옵션값을 조합할 수 있음 ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음. ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨. T : 조합형 E : 연동형 F : 독립형
option_list_type	옵션 표시방식 조합형 옵션을 사용할 경우, 조합형 옵션의 유형 표시 * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨 * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음 독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨. C : 일체형 S : 분리형
option_preset_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	옵션세트 코드 상품연동형 옵션을 사용할 경우, 옵션 세트 코드 표시
options	옵션
select_one_by_option	옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 F : 사용안함
option_preset_name	연동형 옵션 세트명 상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 표시
use_additional_option	추가입력 옵션 사용여부 T : 사용함 F : 사용안함
additional_options	추가입력 옵션
use_attached_file_option	파일 첨부 옵션 사용여부 T : 사용함 F : 사용안함
attached_file_option	파일 첨부 옵션

Retrieve a list of product options

GET /api/v2/admin/products/{product_no}/options

GET

상품의 옵션을 목록으로 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Request Copy

Response Copy

Create product options

POST /api/v2/admin/products/{product_no}/options

POST

상품의 옵션을 생성하여 등록할 수 있습니다.
옵션을 등록하면 품목은 자동으로 생성됩니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
has_option	옵션 사용여부 T : 사용함 F : 사용안함
option_type	옵션 구성방식 옵션을 사용할 경우, 옵션의 유형 입력 ● 조합형 : 옵션명을 기준으로 옵션값을 조합할 수 있음 ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음. ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨. T : 조합형 E : 연동형 F : 독립형
option_list_type	옵션 표시방식 조합형 옵션을 사용할 경우, 조합형 옵션의 유형 입력 * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨 * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음 독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨. S : 조합 분리선택형 C : 조합 일체선택형
options	옵션
option_name Required 옵션명 option_value Array option_text 옵션값 option_image_file 옵션 버튼 이미지 option_color 컬러칩 색상 option_display_type 옵션 표시방식 S : 셀렉트박스 P : 미리보기 B : 텍스트버튼 R : 라디오버튼 DEFAULT S
select_one_by_option	옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 F : 사용안함 독립형에만 존재 체크시 옵션별로 한개씩 선택 값 처리
option_preset_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	옵션세트 코드
option_preset_name	연동형 옵션 세트명 상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 입력
use_additional_option	추가입력 옵션 사용여부 T : 사용함 F : 사용안함
additional_options	추가입력 옵션
additional_option_name Required 추가입력옵션명 additional_option_text_length Required 추가입력옵션 길이제한 1~30 50 100 200 required_additional_option Required 추가입력옵션 필수 여부 T : 필수 F : 선택 DEFAULT T
use_attached_file_option	파일 첨부 옵션 사용여부 T : 사용함 F : 사용안함
attached_file_option	파일 첨부 옵션

Request Copy

Response Copy

Update product options

PUT /api/v2/admin/products/{product_no}/options

PUT

상품의 옵션을 수정할 수 있습니다.
옵션명과 옵션값, 추가입력 옵션과 파일첨부 옵션의 수정만 가능하며, 옵션 항목을 추가하거나 삭제할 수는 없습니다.
또한 생성되어 있는 품목은 초기화하지 않습니다.
옵션을 추가하거나 삭제하고 싶을 경우에는 옵션 삭제 API(Delete a products option)로 삭제하신 후, 다시 등록하시면 됩니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
option_list_type	옵션 표시방식 조합형 옵션을 사용할 경우, 조합형 옵션의 유형 입력 * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨 * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음 독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨. S : 조합 분리선택형 C : 조합 일체선택형
option_preset_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	옵션세트 코드 상품연동형 옵션을 사용할 경우, 옵션 세트 코드 입력
options	옵션
option_name Required 옵션명 option_value Array option_text 옵션값 option_image_file 옵션 버튼 이미지 option_link_image 옵션 연결 이미지 option_color 컬러칩 색상 option_display_type 옵션 표시방식 S : 셀렉트박스 P : 미리보기 B : 텍스트버튼 R : 라디오버튼 DEFAULT S
original_options	수정되기전 옵션값
option_name Required 옵션명 option_value Array option_text 옵션값
select_one_by_option	옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 F : 사용안함 독립형에만 존재 체크시 옵션별로 한개씩 선택 값 처리
option_preset_name	연동형 옵션 세트명 상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 입력
use_additional_option	추가입력 옵션 사용여부 T : 사용함 F : 사용안함
additional_options	추가입력 옵션
additional_option_name Required 추가입력옵션명 additional_option_text_length Required 추가입력옵션 길이제한 1~30 50 100 200 required_additional_option Required 추가입력옵션 필수 여부 T : 필수 F : 선택 DEFAULT T
use_attached_file_option	파일 첨부 옵션 사용여부 T : 사용함 F : 사용안함
attached_file_option	파일 첨부 옵션

Request Copy

Response Copy

Delete a product option

DELETE /api/v2/admin/products/{product_no}/options

DELETE

상품의 옵션을 삭제할 수 있습니다.
옵션을 삭제하면 옵션 기능이 '사용안함' 상태가 되기 때문에 기존에 생성되어 있던 품목도 함께 삭제되므로 주의가 필요합니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Request Copy

Response Copy

Products seo

상품 SEO(Products seo)는 특정 상품의 SEO 에 대한 설정과 설정값의 조회가 가능한 기능입니다.
SEO는 검색엔진 최적화(Search Engine Optimization)의 약자로서 본 기능을 활용하여 검색엔진에 상품이나 쇼핑몰이 더 잘 검색될 수 있도록 할 수 있습니다.
상품 SEO는 상품의 하위 리소스로서 특정 상품의 검색엔진 최적화 설정을 할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/seo
PUT /api/v2/admin/products/{product_no}/seo

Products seo properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
meta_title	브라우저 타이틀 해당 상품의 상품 상세 페이지의 Title 태그에 표시되는 정보. Title 태그는 브라우저에 표시되는 정보로 검색엔진에서 검색시 가장 기본적인 정보이다.
meta_author	메타태그1 : Author 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. author 메타 태그에는 해당 상품을 제조한 사람 또는 등록한 사람을 기입한다.
meta_description	메타태그2 : Description 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. description 태그에 검색 결과 페이지에서 검색 결과 아래에 표시될 간략한 정보를 입력할 수 있다.
meta_keywords	메타태그3 : Keywords 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. keyword 태그에 해당 상품이 검색되었으면 하는 검색 키워드를 입력할 수 있다.
meta_alt	상품 이미지 Alt 텍스트 상품 이미지에 표시되는 Alt 텍스트 정보. Alt 텍스트를 입력해놓으면 검색엔진에서 이미지 검색시 검색될 가능성이 높아지며, 브라우저에서 이미지 대신 해당 텍스트를 출력할 수 있어 웹 접근성에도 유리하다.
search_engine_exposure	검색 엔진 노출 설정 해당 상품을 검색엔진에 노출할 것인지 설정. '노출안함'으로 설정할 경우 해당 상품이 검색엔진에 노출되지 않는다. T : 사용함 F : 사용안함

Retrieve a product's SEO settings

GET /api/v2/admin/products/{product_no}/seo

GET

특정 상품의 SEO 설정을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Request Copy

Response Copy

Update product SEO settings

PUT /api/v2/admin/products/{product_no}/seo

PUT

특정 상품의 SEO 설정을 수정할 수 있습니다.
브라우저 타이틀, 메타태그, 검색엔진 노출 설정 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
meta_title	브라우저 타이틀 해당 상품의 상품 상세 페이지의 Title 태그에 표시되는 정보. Title 태그는 브라우저에 표시되는 정보로 검색엔진에서 검색시 가장 기본적인 정보이다.
meta_author	메타태그1 : Author 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. author 메타 태그에는 해당 상품을 제조한 사람 또는 등록한 사람을 기입한다.
meta_description	메타태그2 : Description 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. description 태그에 검색 결과 페이지에서 검색 결과 아래에 표시될 간략한 정보를 입력할 수 있다.
meta_keywords	메타태그3 : Keywords 해당 상품의 상품 상세 페이지의 태그에 표시되는 정보. keyword 태그에 해당 상품이 검색되었으면 하는 검색 키워드를 입력할 수 있다.
meta_alt	상품 이미지 Alt 텍스트 상품 이미지에 표시되는 Alt 텍스트 정보. Alt 텍스트를 입력해놓으면 검색엔진에서 이미지 검색시 검색될 가능성이 높아지며, 브라우저에서 이미지 대신 해당 텍스트를 출력할 수 있어 웹 접근성에도 유리하다.
search_engine_exposure	검색 엔진 노출 설정 해당 상품을 검색엔진에 노출할 것인지 설정. '노출안함'으로 설정할 경우 해당 상품이 검색엔진에 노출되지 않는다.

Request Copy

Response Copy

Products tags

상품 태그(Products tags)는 상품이 특정 단어로 검색 되어야할 경우 추가할 수 있는 검색 키워드와 관련된 기능입니다.
상품 태그는 하위 리소스로서 상품(Products) 하위에서만 사용할 수 있습니다.
상품명이나 상품 상세 설명 외에 다른 단어로도 상품이 검색되길 원할 경우 검색어를 상품에 추가할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/tags/count
GET /api/v2/admin/products/{product_no}/tags
POST /api/v2/admin/products/{product_no}/tags
DELETE /api/v2/admin/products/{product_no}/tags/{tag}

Products tags properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
tags Required	상품 태그
product_no	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
tag	상품 태그 검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그)

Retrieve a count of a product's product tags

GET /api/v2/admin/products/{product_no}/tags/count

GET

특정 상품에 등록된 상품 태그의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Request Copy

Response Copy

Retrieve a list of a product's product tags

GET /api/v2/admin/products/{product_no}/tags

GET

상품에 등록된 태그를 목록으로 조회할 수 있습니다.
상품 태그, 상품번호 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Request Copy

Response Copy

Create product tags

POST /api/v2/admin/products/{product_no}/tags

POST

특정 상품에 검색 또는 분류를 위한 상품 태그를 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
tags Required 배열 최대사이즈: [50]	상품 태그

Request Copy

Response Copy

Delete a product tag

DELETE /api/v2/admin/products/{product_no}/tags/{tag}

DELETE

특정 상품에 등록된 특정 태그를 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

tag

상품 태그

검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그)

Request Copy

Response Copy

Products variants

상품의 품목(Products variants)은 쇼핑몰에서 판매되는 상품의 기본 단위입니다.
쇼핑몰은 일반적으로 고객에게 다양한 선택권을 제공하기 위해 같은 상품이지만 사이즈가 다르거나, 혹은 색상이 다른 품목들을 판매합니다.
품목의 조회, 등록, 수정 또는 삭제를 할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/variants
GET /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants
DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

Products variants properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
variant_code 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	상품 품목 코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.
options	옵션
custom_variant_code 최대글자수 : [40자]	자체 품목 코드 사용자가 품목에 부여 가능한 코드. 재고 관리 등의 이유로 자체적으로 상품을 관리하고 있는 경우 사용함.
display	진열상태 해당 품목을 진열할지 여부. 품목을 진열할 경우 상품 상세 또는 상품 목록에서 해당 품목을 선택할 수 있다. 품목이 진열되어있지 않을 경우 해당 품목이 표시되지 않으며 해당 품목을 구매할 수 없다. T : 판매함 F : 판매안함
selling	판매상태 해당 품목을 판매할지 여부. 진열은 되어있으나 판매는 하지 않을 경우 해당 품목은 "품절"로 표시되며 해당 품목을 구매할 수 없다. 품목이 "판매함" 상태여도 "진열안함"으로 되어있다면 해당 품목을 구매할 수 없다. T : 진열함 F : 진열안함
additional_amount	추가금액 해당 품목을 구매할 경우, 상품의 판매가에 더하여 지불해야하는 추가 가격.
use_inventory	재고 사용여부 T : 사용함 F : 사용안함
important_inventory	중요재고 여부 A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 A : 주문기준 B : 결제기준
display_soldout	품절표시여부 T : 품절표시 사용 F : 품절표시 사용안함
quantity	수량
safety_inventory	안전재고수량
image	품목 이미지
inventories	재고 리소스 품목의 재고 리소스
duplicated_custom_variant_code	자체품목코드 중복여부 T : 중복됨 F : 중복안됨
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

Retrieve a list of product variants

GET /api/v2/admin/products/{product_no}/variants

GET

상품의 품목을 목록으로 조회할 수 있습니다.
상품 품목 코드, 진열상태, 판매상태 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

inventories
embed

재고 리소스

품목의 재고 리소스
조회시 Embed 파라메터를 사용하여 조회할 수 있다.

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Retrieve a product variant

GET /api/v2/admin/products/{product_no}/variants/{variant_code}

GET

상품의 특정 품목을 조회할 수 있습니다.
옵션정보, 자체 품목 코드, 진열 및 판매상태 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드
inventories embed	재고 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.

Request Copy

Response Copy

Update a product variant

PUT /api/v2/admin/products/{product_no}/variants/{variant_code}

PUT

상품의 특정 품목을 수정할 수 있습니다.
자체 품목 코드, 진열상태, 판매상태, 추가금액 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	상품 품목 코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.
custom_variant_code 최대글자수 : [40자]	자체 품목 코드 사용자가 품목에 부여 가능한 코드. 재고 관리 등의 이유로 자체적으로 상품을 관리하고 있는 경우 사용함.
display	진열상태 해당 품목을 진열할지 여부. 품목을 진열할 경우 상품 상세 또는 상품 목록에서 해당 품목을 선택할 수 있다. 품목이 진열되어있지 않을 경우 해당 품목이 표시되지 않으며 해당 품목을 구매할 수 없다. T : 진열함 F : 진열안함
selling	판매상태 해당 품목을 판매할지 여부. 진열은 되어있으나 판매는 하지 않을 경우 해당 품목은 "품절"로 표시되며 해당 품목을 구매할 수 없다. 품목이 "판매함" 상태여도 "진열안함"으로 되어있다면 해당 품목을 구매할 수 없다. T : 판매함 F : 판매안함
additional_amount	추가금액 해당 품목을 구매할 경우, 상품의 판매가에 더하여 지불해야하는 추가 가격.
quantity	수량
use_inventory	재고 사용여부 T : 사용함 F : 사용안함
important_inventory	중요재고 여부 A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 A : 주문기준 B : 결제기준
display_soldout	품절표시여부 T : 품절표시 사용 F : 품절표시 사용안함
safety_inventory	안전재고수량

Request Copy

Response Copy

Update multiple product variants

PUT /api/v2/admin/products/{product_no}/variants

PUT

상품의 여러 품목을 한번에 수정할 수 있습니다.
품목의 진열상태, 판매상태, 재고 사용여부 등을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	상품 품목 코드
custom_variant_code 최대글자수 : [40자]	자체 품목 코드
display	진열상태 T : 진열함 F : 진열안함
selling	판매상태 T : 판매함 F : 판매안함
additional_amount	추가금액
quantity	수량
use_inventory	재고 사용여부 T : 사용함 F : 사용안함
important_inventory	중요재고 여부 A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 A : 주문기준 B : 결제기준
display_soldout	품절표시여부 T : 품절표시 사용 F : 품절표시 사용안함
safety_inventory	안전재고수량

Request Copy

Response Copy

Delete a product variant

DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

DELETE

상품의 특정 품목을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

variant_code
Required

형식 : [A-Z0-9]
글자수 최소: [12자]~최대: [12자]

상품 품목 코드

시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.

Request Copy

Response Copy

Products variants inventories

재고(Inventories)는 판매 가능한 해당 품목의 수량을 의미합니다. 재고는 품목(Variants)별로 존재하며 해당 재고 이상 품목이 판매되면 해당 상품은 품절 상태가 됩니다.

Endpoints

GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

Products variants inventories properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
variant_code 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않는다.
use_inventory	재고 사용여부 해당 품목에서 재고 관리를 사용할 것인지 여부. 해당 품목에 재고 관리를 사용할 경우 재고 수량을 입력할 수 있다. 재고 관리를 사용하지 않을 경우 해당 상품은 재고와 관계 없이 판매할 수 있으며, 재고 수량, 재고수량 체크 기준, 품절 표시 여부를 사용할 수 없다. T : 사용함 F : 사용안함
important_inventory	중요재고 여부 해당 재고를 중요하게 관리하는지 여부. 쇼핑몰에서는 검색을 하기위한 구분 데이터로 사용한다. A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 재고 수량을 어느 시점에 차감할 것인지 여부. 무통장 입금처럼 결제 시점과 주문 시점이 다른 경우 재고를 차감하는 기준을 다르게 설정할 수 있다. 주문 기준 : 주문한 시점에 재고 차감. 무통장 입금의 경우 입금 완료가 되지 않아도 재고를 차감한다. 결제 기준 : 결제한 시점에 재고 차감. 무통장 입금의 경우 입금 완료가 된 다음 재고를 차감한다. A : 주문기준 B : 결제기준
display_soldout	품절표시여부 재고가 다 판매되었을 경우 해당 품목을 품절로 표시할 것인지 여부. 품절로 표시되면 주문을 할 수 없다. 모든 품목이 품절이 될 경우 해당 상품에 품절 아이콘이 표시된다. "표시안함" 선택시 재고가 다 판매되어도 주문이 가능하며 재고가 마이너스(-)로 표기된다. T : 품절표시 사용 F : 품절표시 사용안함
quantity	수량 해당 품목에 판매가 가능한 재고 수량. 재고 수량은 주문 또는 결제시 차감되며, 품절 표시를 위하여 체크된다.
safety_inventory	안전재고수량
origin_code	출고지 코드

Retrieve inventory details of a product variant

GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

GET

상품의 품목의 재고를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 읽기권한 (mall.read_product)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

variant_code
Required

형식 : [A-Z0-9]
글자수 최소: [12자]~최대: [12자]

품목코드

판매 수량을 검색할 품목 코드

Request Copy

Response Copy

Update a product variant inventory

PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

PUT

상품의 품목의 재고에 관한 정보를 수정할 수 있습니다.
재고 관리의 사용여부, 중요재고의 여부, 안전재고 설정, 재고수량 수정 등을 할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품 쓰기권한 (mall.write_product)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no Required	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않는다.
use_inventory	재고 사용여부 해당 품목에서 재고 관리를 사용할 것인지 여부. 해당 품목에 재고 관리를 사용할 경우 재고 수량을 입력할 수 있다. 재고 관리를 사용하지 않을 경우 해당 상품은 재고와 관계 없이 판매할 수 있으며, 재고 수량, 재고수량 체크 기준, 품절 표시 여부를 사용할 수 없다. T : 사용함 F : 사용안함
important_inventory	중요재고 여부 해당 재고를 중요하게 관리하는지 여부. 쇼핑몰에서는 검색을 하기위한 구분 데이터로 사용한다. A : 일반재고 B : 중요재고
inventory_control_type	재고 수량체크 기준 재고 수량을 어느 시점에 차감할 것인지 여부. 무통장 입금처럼 결제 시점과 주문 시점이 다른 경우 재고를 차감하는 기준을 다르게 설정할 수 있다. 주문 기준 : 주문한 시점에 재고 차감. 무통장 입금의 경우 입금 완료가 되지 않아도 재고를 차감한다. 결제 기준 : 결제한 시점에 재고 차감. 무통장 입금의 경우 입금 완료가 된 다음 재고를 차감한다. A : 주문기준 B : 결제기준
display_soldout	품절표시여부 재고가 다 판매되었을 경우 해당 품목을 품절로 표시할 것인지 여부. 품절로 표시되면 주문을 할 수 없다. 모든 품목이 품절이 될 경우 해당 상품에 품절 아이콘이 표시된다. "표시안함" 선택시 재고가 다 판매되어도 주문이 가능하며 재고가 마이너스(-)로 표기된다. T : 품절표시 사용 F : 품절표시 사용안함
quantity	수량 해당 품목에 판매가 가능한 재고 수량. 재고 수량은 주문 또는 결제시 차감되며, 품절 표시를 위하여 체크된다.
safety_inventory	안전재고수량
origin_code	출고지 코드

Request Copy

Response Copy

Cancellation

취소(Cancellation)는 특정 주문을 배송 전에 취소하는 기능입니다.
판매자가 접수한 이후부터 생성되며 취소처리중의 단계를 거쳐 취소완료까지 진행됩니다.
취소 리소스에서는 복수의 주문을 한번에 취소하거나 취소 상태를 수정하거나 조회할 수 있습니다.
특정 주문을 취소할 때와 달리 PG 취소까지 진행되도록 취소할 수는 없습니다.

Endpoints

GET /api/v2/admin/cancellation/{claim_code}
POST /api/v2/admin/cancellation
PUT /api/v2/admin/cancellation

Cancellation properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
claim_code	취소번호
claim_reason_type	구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	사유
refund_methods	환불 방식
refund_reason	비고
order_price_amount	상품구매금액
refund_amounts	환불금액
shipping_fee	배송비
return_ship_type	반품배송비 적용구분
defer_commission	후불 결제 수수료
partner_discount_amount	제휴할인 취소액
add_discount_amount	상품별추가할인 취소액
member_grade_discount_amount	회원등급할인 취소액
shipping_discount_amount	배송비할인 취소액
coupon_discount_amount	쿠폰할인 취소액
point_used	사용된 적립금 반환액
credit_used	사용된 예치금 반환액
undone	철회 여부 T : 철회함 F : 철회안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason	주문상세내역 노출 철회 사유
items	품주코드
include_tax	가격에 세금 포함 T: 세금포함 F: 세금제외
tax	세금 정보 세금 관리자 앱을 사용 안 할 경우 null로 반환
status	주문상태 canceled : 취소완료 canceling : 취소처리중
recover_inventory	재고복구 T : 복구함 F : 복구안함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함

Retrieve an order cancellation

GET /api/v2/admin/cancellation/{claim_code}

GET

취소 완료되었거나 취소처리 진행중인 내역을 조회할 수 있습니다.
환불 방식, 환불금액, 철회 사유 구분 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

claim_code
Required

취소번호

Request Copy

Response Copy

Create multiple order cancellations

POST /api/v2/admin/cancellation

POST

배송 전의 여러 주문을 취소할 수 있습니다.
해당 API를 사용하여 취소할 경우 환불완료 처리까지는 되지만 PG 취소까지는 진행되지 않으며 별도 PG 취소처리를 해주어야 합니다.
부분취소할 경우 각 환불 금액은 자동 계산되어 환불처리 됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
status Required	주문상태 canceled : 취소완료 canceling : 취소처리중
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon_no	복원할 쿠폰 번호
add_memo_too	관리자 메모에도 추가 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	취소사유
claim_reason_type	취소사유 구분 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_cancel_reason_type	네이버페이 취소사유 구분 쇼핑몰/오픈마켓/카카오페이 주문을 취소할 경우 사용 불가 EC 베트남, 필리핀 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 60 : 상품 정보 상이
kakaopay_cancel_reason_type	카카오페이 취소사유 구분 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 K1 : 변심에 의한 상품 취소 K2 : 다른 옵션이나 상품을 잘못 주문함 K3 : 배송지연 K4 : 상품 파손 또는 불량 K5 : 다른 상품 오배송 또는 구성품 누락 K6 : 상품정보와 다름 K7 : 품절로 인한 배송 불가
refund_method_code	환불 방식 (오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가) T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 J : 제휴상품권 K : 제휴포인트 I : 기타
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가
refund_bank_name 최대글자수 : [250자]	환불은행명 환불 방식(refund_method)이 현금(T)일 경우 필수 ※ 해당 쇼핑몰이 EC Global 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가
refund_bank_account_no	환불 계좌번호 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code Required 품주코드 quantity Required 수량

Request Copy

Response Copy

Change cancellation details in bulk

PUT /api/v2/admin/cancellation

PUT

주문의 취소 상태를 수정할 수 있습니다.
취소가 접수된 주문의 주문 상태를 취소 접수 이전 상태로 철회할 수 있습니다.
주문의 취소 상태를 수정하여 취소접수를 철회하고 재고를 복구하거나 철회사유를 입력할 수 있습니다.
택배사에 이미 수거요청이 전달되었으나 수거가 필요하지 않게 될 경우, 택배사에 직접 연락하셔서 수거요청을 취소해주셔야 합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
claim_code Required	취소번호
recover_inventory Required	재고복구 T : 복구함 F : 복구안함
undone Required	철회 여부 T : 철회함
add_memo_too Required	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type Required	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason 최대글자수 : [2000자]	철회 사유
expose_order_detail Required	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason 최대글자수 : [2000자]	주문상세내역 노출 철회 사유

Request Copy

Response Copy

Cancellationrequests

취소요청(Cancellationrequests)은 주문에 대한 취소요청에 관한 기능입니다.
취소를 요청하거나 취소요청중인 주문을 접수거부 할 수 있습니다.

Endpoints

POST /api/v2/admin/cancellationrequests
PUT /api/v2/admin/cancellationrequests

Cancellationrequests properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
items	품주 목록
undone	접수거부 여부
order_item_code	품주코드

Create a cancellation request for multiple items

POST /api/v2/admin/cancellationrequests

POST

취소를 요청할 수 있습니다.
취소사유와 계좌환불인 경우 환불할 계좌번호를 입력할 수 있습니다.
,(콤마)로 여러 건을 동시에 취소요청 할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
reason_type Required	취소사유 구분 A:고객변심 B:배송지연 G:서비스불만족 I:기타
reason Required 최대글자수 : [2000자]	취소사유
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no	환불 계좌번호
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주 목록
order_item_code Required 품주코드 quantity Required 수량

Request Copy

Response Copy

Reject a cancellation request for multiple items

PUT /api/v2/admin/cancellationrequests

PUT

취소가 요청된 주문의 특정 품주들에 대하여 취소요청중인 상태를 변경할 수 있습니다.
접수거부를 할 수 있고 사유를 입력할 수 있습니다.
,(콤마)로 여러 건을 동시에 취소요청 할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
order_item_code Required	품주코드
undone Required	접수거부 여부 T : 접수거부함
reason_type	사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
reason 최대글자수 : [2000자]	사유
display_reject_reason	주문상세내역 노출설정 T : 노출함 F : 노출안함 DEFAULT F
reject_reason 최대글자수 : [2000자]	거부 사유

Request Copy

Response Copy

Cashreceipt

현금영수증(Cashreceipts)은 현금으로 구매 후 구매자가 발급 받을 수 있는 결제 증빙입니다.
현금영수증 리소스를 통해 현금영수증을 발급하거나 수정할 수 있고, 현재까지 발급된 현금영수증을 조회할 수 있습니다.
현금영수증은 대한민국에만 있는 제도로, 한국 쇼핑몰에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/cashreceipt
POST /api/v2/admin/cashreceipt
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

Cashreceipt properties

Attribute	Description
cashreceipt_no	현금영수증 번호
approval_no	승인번호
request_date	신청일자
order_id	주문번호
member_id	회원아이디
name	요청자 이름
order_price_amount	상품구매금액
vat	부가세
subtotal	총 신청금액
order_status	주문상태 입금전: unpaid 미배송: unshipped 배송중: shipping 배송대기: standby 배송완료: shipped 부분취소: partially_canceled 전체취소: canceled
status	처리상태 신청: request 발행대기: await_issuance 발행: issued 발행거부: issuance_rejected 신청취소: canceled_request 발행취소: canceled_issuance 발행실패: failed_issuance
pg_name	신청결제사
cash_bill_no	현금영수증 일련 번호
type	발행 타입 개인: personal 사업자: business
company_registration_no	사업자등록번호
cellphone	휴대전화
tax_amount	과세금액
tax_free_amount	면세금액
supply_price	공급가액

Retrieve a list of cash receipts

GET /api/v2/admin/cashreceipt

GET

현재까지 발급된 현금영수증을 조회할 수 있습니다.
해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
order_id 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
approval_no 최대글자수 : [9자]	승인번호
name 최대글자수 : [20자]	요청자 이름
member_id 최대글자수 : [20자]	회원아이디
status	처리상태 전체: all 신청: request 발행: issued 신청취소: canceled_request 발행취소: canceled_issuance 발행실패: failed_issuance DEFAULT all
limit 최소: [1]~최대: [500]	조회결과 최대건수 DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Create a cash receipt

POST /api/v2/admin/cashreceipt

POST

특정 주문 번호에 대해 현금영수증을 발급해줄 수 있습니다.
해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
order_id Required 주문번호	주문번호
type Required	발행 타입 개인: personal 사업자: business
company_registration_no 사업자번호 최대글자수 : [10자]	사업자등록번호
cellphone 모바일 최대글자수 : [11자]	휴대전화

Request Copy

Response Copy

Update a cash receipt

PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

PUT

발급된 현금 영수증 정보를 수정할 수 있습니다.
해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
cashreceipt_no Required 최소값: [1]	현금영수증 번호
order_id Required 주문번호	주문번호
type	발행 타입 개인: personal 사업자: business
company_registration_no 사업자번호 최대글자수 : [10자]	사업자등록번호
cellphone 모바일 최대글자수 : [11자]	휴대전화

Request Copy

Response Copy

Cashreceipt cancellation

현금영수증 취소(Cashreceipt cancellation)는 발행된 현금영수증에 대해 신청취소 혹은 발행취소를 할 수 있는 기능입니다.

Endpoints

PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

Cashreceipt cancellation properties

Attribute

Description

cashreceipt_no

현금영수증 번호

order_id

주문번호

status

처리상태

신청취소: canceled_request
발행취소: canceled_issuance

Update a cash receipt cancellation

PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

PUT

발행된 현금영수증에 대해 신청취소 혹은 발행취소를 할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

cashreceipt_no
Required

최소값: [1]

현금영수증 번호

order_id
Required

주문번호

주문번호

type
Required

취소 타입

신청취소: request
발행취소: issue

Request Copy

Response Copy

Collectrequests

수거신청 정보(Collectrequests)는 반품, 교환처리로 수거요청시 수거신청 정보를 수정할 수 있는 리소스입니다.

Endpoints

PUT /api/v2/admin/collectrequests/{request_no}

Collectrequests properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
request_no	요청 번호
order_id	주문번호
order_item_code	품주코드
shipping_company_name	수거 배송사명
collect_tracking_no	수거 송장 번호

Update a collection request

PUT /api/v2/admin/collectrequests/{request_no}

PUT

채번되는 송장번호를 이용하여 수거신청 정보를 수정합니다.
요청번호와 수거 송장 번호를 필수로 입력합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	30
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

request_no
Required

요청 번호

collect_tracking_no
Required

최대글자수 : [40자]

수거 송장 번호

Request Copy

Response Copy

Draftorders

가주문(Draftorders)은 주문 예약 처리를 할 수 있는 기능입니다.
가주문을 통해 결제 전에 주문번호, 결제금액 등의 주문 정보를 미리 확인할 수 있습니다.

Endpoints

POST /api/v2/admin/draftorders

Draftorders properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문 번호
payment_amount	가주문 가격 정보
order_from_mobile	모바일 구분 T : 모바일 주문 F : 모바일 주문 아님 DEFAULT F
payment_method 최대글자수 : [10자]	결제수단 코드 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 icash : 가상계좌 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 coupon : 쿠폰 market_discount : 마켓할인 etc : 기타
items	주문상품목록

Create a draft order

POST /api/v2/admin/draftorders

POST

주문 예약 처리를 합니다.
주문 예약 처리를 통해 결제 전에 주문번호,결제금액 등의 주문 정보를 미리 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
member_id 최대글자수 : [20자]	회원아이디
order_from_mobile	모바일 구분 T : 모바일 주문 F : PC 주문 DEFAULT F
payment_method 최대글자수 : [10자]	결제수단 코드 cash : 무통장 card : 신용카드 icash : 가상계좌 tcash : 계좌이체 cell : 휴대폰 deferpay : 후불결제 point : 적립금
order_place_id 형식 : [a-zA-Z0-9_-] 최대글자수 : [40자]	주문경로 self : PC 쇼핑몰(카페24 주문만 사용가능) mobile : 모바일웹(카페24 주문만 사용가능) mobile_d : 모바일앱(카페24 주문만 사용가능) PAYPALSMARTBUTTON : 페이팔 스마트 버튼
country_code	국가코드
payment_gateway_name 최대글자수 : [20자]	PG사 명
receiver_name Required 최대글자수 : [100자]	수령자 명
receiver_name_en 최대글자수 : [100자]	수령자명 (영문)
receiver_name_furigana 최대글자수 : [100자]	수령자명 (발음)
receiver_phone Required	수령자 일반 전화
receiver_cellphone Required	수령자 휴대 전화
receiver_zipcode 글자수 최소: [2자]~최대: [14자]	수령자 우편번호
receiver_address1	수령자 기본 주소
receiver_address2	수령자 상세 주소
receiver_city	수령자 도시
receiver_state	수령자 주/지방
shipping_message	배송 메세지
buyer_name Required 최대글자수 : [100자]	주문자 이름
buyer_email 이메일	주문자 이메일
buyer_phone	주문자 일반 전화
buyer_cellphone	주문자 휴대 전화
buyer_zipcode Required 글자수 최소: [2자]~최대: [14자]	주문자 우편번호
buyer_address1 Required 최대글자수 : [250자]	주문자 기본 주소
buyer_address2 Required	주문자 상세 주소
no_shipping_required	배송 주소 없음 T: 배송 주소 없음 F: 배송 주소 있음 DEFAULT F
buyer_ip IP	주문자 ip
transaction_id 최대글자수 : [100자]	카드 거래 아이디
bank_code 형식 : [a-z0-9_-]	은행코드
bank_account_no 최대글자수 : [30자]	계좌번호
bank_account_owner_name 최대글자수 : [100자]	예금주
shipping_type	배송 유형 A : 국내 B : 해외
send_order_message	신규 주문 안내 메세지 발송 여부 T : 발송함 F : 발송안함 DEFAULT F
send_payment_guide_message	입금 안내 메세지 발송 여부 T : 발송함 F : 발송안함 DEFAULT F
send_order_email	신규 주문 안내 메일 발송 여부 T : 발송함 F : 발송안함 DEFAULT F
clearance_information_type	통관정보 유형 I : 신분증 ID P : 여권번호 C : 개인통관고유부호
clearance_information	통관정보
self_payment_cancel	자체 결제 취소 여부 T: 취소가능 F: 취소불가 DEFAULT F
self_payment_cancel_url	자체 결제 취소 URL
items	주문상품목록
product_no Required 상품번호 product_code Required 상품코드 option_id Required 상품옵션 아이디 quantity Required 주문 수량 product_bundle 세트상품 여부 T : 사용함 F : 사용안함 prepaid_shipping_fee 배송비 선결제 설정 P : 선불 C : 착불 product_bundle_no 세트상품번호

Request Copy

Response Copy

Exchange

교환(Exchange)은 주문의 교환 접수 상태를 변경하는 리소스입니다.
교환 접수를 할 수 있으며 교환이 접수된 주문의 상태를 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/exchange/{claim_code}
POST /api/v2/admin/exchange
PUT /api/v2/admin/exchange

Exchange properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
claim_code	반품번호
claim_reason_type	구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	사유
claim_due_date	교환처리 예정일
receiver	수령자
reshipping_detail	교환 재발송 정보
pickup	수거지 - 주소
additional_payment	추가결제
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name	반품 배송업체명
refund_methods	환불 방식
refund_reason	비고
order_price_amount	상품구매금액
refund_amounts	환불금액
shipping_fee	배송비
return_ship_type	반품배송비 적용구분
defer_commission	후불 결제 수수료
partner_discount_amount	제휴할인 취소액
add_discount_amount	상품별추가할인 취소액
member_grade_discount_amount	회원등급할인 취소액
shipping_discount_amount	배송비할인 취소액
coupon_discount_amount	쿠폰할인 취소액
point_used	사용된 적립금 반환액
credit_used	사용된 예치금 반환액
undone	철회 여부 T : 철회함 F : 철회안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason	주문상세내역 노출 철회 사유
items	품주코드
exchanged_items	교환상품
include_tax	가격에 세금 포함 T: 세금포함 F: 세금제외
tax	세금 정보 세금 관리자 앱을 사용 안 할 경우 null로 반환
carrier_id	배송사 아이디
return_invoice_success	반송장 처리 성공 여부 T : 성공 F : 실패 N : 미집하
return_invoice_fail_reason 최대글자수 : [100자]	반송장 처리 실패 사유
status	주문상태 accept : 접수 collected : 수거완료 exchanged : 교환완료
recover_inventory	재고복구 T : 복구함 F : 복구안함
exchanged_after_collected	수거완료시 교환완료 여부 T : 사용함 F : 사용안함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전

Retrieve an exchange

GET /api/v2/admin/exchange/{claim_code}

GET

교환번호를 입력하여, 교환이 접수된 주문건을 조회합니다.
주문번호, 반품번호, 사유, 교환처리 예정일 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

claim_code
Required

교환번호

Request Copy

Response Copy

Create multiple exchanges

POST /api/v2/admin/exchange

POST

교환이 신청된 주문의 상태를 교환접수 혹은 교환완료로 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
status Required	주문상태 accepted : 교환접수 exchanged : 교환완료
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함 DEFAULT F
items	품주코드
order_item_code Required 품주코드 quantity Required 수량 exchange_variant_code (동일상품 다른 옵션 교환시) 교환 상품 품목 코드
same_product Required	동일상품교환 여부 T : 동일상품교환 F : 다른상품교환

Request Copy

Response Copy

Update multiple order exchanges

PUT /api/v2/admin/exchange

PUT

교환이 접수된 주문의 상태를 수정 할 수 있습니다.
다건의 주문에 대해 교환접수를 철회하거나, 재고를 복구하거나, 철회사유를 입력할 수 있습니다.
택배사에 이미 수거요청이 전달되었으나 수거가 필요하지 않게 될 경우, 택배사에 직접 연락하셔서 수거요청을 취소해주셔야 합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
claim_code Required	교환번호
status	주문상태 exchanged : 교환완료
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전
recover_inventory	재고복구 T : 복구함 F : 복구안함
exchanged_after_collected	수거완료시 교환완료 여부 T : 사용함 F : 사용안함
items	품주코드
order_item_code 품주코드
undone	철회 여부 T : 철회함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason 최대글자수 : [2000자]	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason 최대글자수 : [2000자]	주문상세내역 노출 철회 사유
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
carrier_id	배송사 아이디
return_invoice_success	반송장 처리 성공 여부 T : 성공 F : 실패 N : 미집하
return_invoice_fail_reason 최대글자수 : [100자]	반송장 처리 실패 사유

Request Copy

Response Copy

Exchangerequests

교환요청(Exchangerequests)은 주문에 대해 교환을 요청할 수 있는 기능입니다.

Endpoints

POST /api/v2/admin/exchangerequests
PUT /api/v2/admin/exchangerequests

Exchangerequests properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
items	품주 목록
exchange_request_no	교환신청번호
undone	접수거부 여부
order_item_code	품주코드
additional_payment_gateway_cancel	추가 PG 취소

Bulk exchange request API

POST /api/v2/admin/exchangerequests

POST

특정 주문에 대해 교환요청 처리를 할 수 있습니다.
,(콤마)로 여러 건을 동시에 교환요청 할 수 있습니다.
교환사유와 수거신청 여부를 함께 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
reason_type Required	사유 구분 A:고객변심 E:상품불만족 K:상품불량 J:배송오류 I:기타
reason Required 최대글자수 : [2000자]	교환신청 사유
request_pickup	수거신청 여부 T : 수거신청 F : 직접발송
pickup	수거지역 상세
name Required 이름 phone 전화번호 cellphone Required 휴대전화 zipcode Required 우편번호 address1 Required 기본 주소 address2 Required 상세 주소
tracking_no 최대글자수 : [40자]	반품 송장 번호
shipping_company_name 최대글자수 : [30자]	반품 배송업체명
refund_bank_code	환불 은행 코드
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no	환불 계좌번호
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주 목록
order_item_code Required 품주코드 quantity Required 수량
exchange_items	교환상품정보
product_no Required 상품번호 variant_code Required 상품 품목 코드 quantity Required 수량

Request Copy

Response Copy

Reject an exchange request for multiple items

PUT /api/v2/admin/exchangerequests

PUT

교환이 요청된 주문의 특정 품주들에 대하여 교환요청중인 상태를 변경할 수 있습니다.
접수거부를 할 수 있고 사유를 입력할 수 있습니다.
,(콤마)로 여러 건의 교환요청 건에 대해 동시에 상태 변경 할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
order_item_code Required	품주코드
undone Required	접수거부 여부 T : 접수거부함
reason_type	사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
reason 최대글자수 : [2000자]	사유
display_reject_reason	주문상세내역 노출설정 T : 노출함 F : 노출안함 DEFAULT F
reject_reason 최대글자수 : [2000자]	거부 사유

Request Copy

Response Copy

Fulfillments

배송앱에서 N개의 배송사와 연동하여 배송 정보를 등록하는 기능입니다.

Endpoints

POST /api/v2/admin/fulfillments

Fulfillments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
tracking_no	송장번호
shipping_company_code	배송업체 코드
status	주문상태 standby : 배송대기 shipping : 배송중
order_id	주문번호
shipping_code	배송번호
order_item_code	품주코드
carrier_id	배송사 아이디
post_express_flag	우체국 택배연동

Create shipping information for multiple orders via Fulfillment

POST /api/v2/admin/fulfillments

POST

배송앱에서 여러 주문에 대해 배송 정보를 등록할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
tracking_no Required 최대글자수 : [30자]	송장번호
shipping_company_code Required	배송업체 코드
status Required	주문상태 standby : 배송대기 shipping : 배송중
order_id	주문번호
shipping_code	배송번호
order_item_code	품주코드
carrier_id	배송사 아이디
post_express_flag	우체국 택배연동 S : 송장 전송 완료

Request Copy

Response Copy

Labels

Labels(주문 라벨)이란, 각각의 주문을 쉽게 식별하고 구분할 수 있도록 도와주는 기능입니다.

Endpoints

GET /api/v2/admin/labels
POST /api/v2/admin/labels

Labels properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
names	주문 라벨명
name	주문 라벨명
order_item_code	품주코드

Retrieve order labels

GET /api/v2/admin/labels

GET

특정 주문의 라벨을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

limit

최소: [1]~최대: [1000]

조회결과 최대건수

DEFAULT 100

offset

최대값: [15000]

조회결과 시작위치

DEFAULT 0

Request Copy

Response Copy

Create multiple order labels

POST /api/v2/admin/labels

POST

특정 주문에 라벨을 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

name
Required

주문 라벨명

order_item_code
Required

품주코드

Request Copy

Response Copy

Orders

주문(Order)은 쇼핑몰에서 고객이 상품의 구매의사를 쇼핑몰에 요청한 내역입니다.
결제수단이 무통장입금인 경우 입금전에도 주문은 생성됩니다.
쇼핑몰 운영자는 결제가 완료된 주문 정보를 참고하여 쇼핑몰 고객에게 물건을 배송합니다.
주문 정보에는 주문과 결제를 진행한 주문자의 정보와 상품을 배송 받을 수령자 정보가 포함됩니다.
주문은 품주, 주문자정보 등 여러 하위 리소스들을 갖고 있습니다.

Endpoints

GET /api/v2/admin/orders
GET /api/v2/admin/orders/{order_id}
GET /api/v2/admin/orders/count
PUT /api/v2/admin/orders
PUT /api/v2/admin/orders/{order_id}

Orders properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
currency	화폐단위 해당 멀티쇼핑몰의 화폐단위
order_id	주문번호
market_id	마켓 구분값 가격 비교 사이트를 통하여 마켓 등에서 상품 구매 시 해당 사이트를 구분하기 위한 ID
market_order_no	마켓 주문 번호
member_id	회원아이디
member_email	회원 이메일
member_authentication	회원인증여부 회원 인증여부. 인증여부에 따라 3가지로 회원타입이 나눠짐. T : 승인 B : 특별관리회원 J : 14세미만회원
billing_name	결제자명 입금자 이름. 주문자 혹은 수령자 이름과는 다를 수 있음.
bank_code	은행코드 bank_code
bank_code_name	입금자 은행명
payment_method	결제수단 코드 주문자가 이용한 결제수단의 코드 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 icash : 가상계좌 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 coupon : 쿠폰 market_discount : 마켓할인 giftcard : 제휴상품권 pointcard : 제휴포인트 etc : 기타
payment_method_name	결제수단명 주문자가 이용한 결제수단의 이름
payment_gateway_names	PG 이름
sub_payment_method_name	해외 결제수단명
sub_payment_method_code	해외 결제수단코드 sub_payment_method_code
transaction_ids	카드 거래 아이디
paid	결제 여부 결제가 완료되었는지 여부 T : 결제 F : 미결제 M : 부분 결제
canceled	취소 여부 T : 취소 F : 미취소 M : 부분 취소
order_date	주문일
first_order	최초 주문여부 해당 주문이 최초 주문인지 여부 T : 최초 주문 F : 최초 주문 아님
payment_date	결제일
order_from_mobile	모바일 구분 주문이 모바일에서 이루어졌는지 여부 T : 모바일 주문 F : 모바일 주문 아님
use_escrow	에스크로 사용여부 에스크로를 사용했는지 여부 T : 에스크로 사용 F : 에스크로 미사용
group_no_when_ordering	주문시 회원등급
initial_order_amount	최초 주문 금액
actual_order_amount	현재 주문 금액 실결제금액 중 coupon_shipping_fee_amount는 할인 금액 자동 계산을 사용할 때만 품목별로 배송비 배분이 가능하기 때문에 할인 금액 자동 계산 기능을 사용할 때만 노출됨
bank_account_no	계좌번호 해당 주문건에 대한 쇼핑몰의 계좌번호
bank_account_owner_name	예금주
market_seller_id	마켓 판매자 아이디
payment_amount	최종 결제 금액
cancel_date	주문취소일
order_place_name	주문경로 텍스트
order_place_id	주문경로
payment_confirmation	후불결제 입금확인 가능 여부 T : 입금확인 F : 입금미확인
commission	결제 수수료
postpay	후불결제여부 T : 후불결제 F : 후불결제 아님
admin_additional_amount	관리자 입력 금액
additional_shipping_fee	추가 배송비
international_shipping_insurance	해외배송 보험료
additional_handling_fee	해외배송 부가금액
shipping_type	배송 유형 배송 유형. 국내배송인지 해외배송인지 여부 A : 국내 B : 해외
shipping_type_text	배송 유형명 배송 유형. 국내배송인지 해외배송인지 여부
shipping_status	배송상태 F : 배송전 M : 배송중 T : 배송완료 W : 배송보류 X : 발주전
wished_delivery_date	희망배송일
wished_delivery_time	희망배송시간
wished_carrier_id	희망배송사 코드
wished_carrier_name	희망배송사 명
return_confirmed_date	반품승인일시
total_supply_price	총 공급가액
naver_point	네이버포인트
additional_order_info_list	주문서 추가항목
store_pickup	매장수령여부 T : 매장수령 F : 매장수령 아님
easypay_name	간편결제 결제사 이름
loan_status	여신상태 OK : GOOD NG : NOT GOOD ER : ERROR
subscription	정기결제 여부 T : 정기결제 F : 정기결제 아님
items	품주 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
receivers	수령자정보 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
buyer	주문자정보 리소스
shipping_fee_detail	배송비 정보
regional_surcharge_detail	지역별 배송비 정보
return	반품상세 리소스
cancellation	취소상세 리소스
exchange	교환상세 리소스
multiple_addresses	멀티 배송지 여부 T : 멀티 배송지 주문 F : 멀티 배송지 주문 아님
exchange_rate	결제 화폐 환율 정보
first_payment_methods	최초 결제수단 코드 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 icash : 가상계좌 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 giftcard : 제휴상품권 pointcard : 제휴포인트 etc : 기타
naverpay_payment_information	네이버페이 PG 결제 정보 P : PG결제 N : 네이버결제
include_tax	가격에 세금 포함 T: 세금포함 F: 세금제외
tax_detail	세금 상세 정보
service_type	주문 서비스 유형 rental : 렌탈주문
service_data	주문 서비스 데이터
show_shipping_address	배송지 정보 표기 여부 T: 배송지 정보 표기 F: 배송지 정보 가림
social_member_code	연동 된 SNS 제공코드
social_name	연동 된 SNS명
customer_group_no_when_ordering	주문시 회원등급 주문 당시의 회원등급
benefits	혜택 리소스
coupons	쿠폰 리소스
refunds	환불상세 리소스
process_status	주문상태 prepare : 배송준비중 prepareproduct : 상품준비중 hold : 배송보류 unhold : 배송보류해제
order_item_code	품주코드
purchase_confirmation	구매확정 여부
collect_points	적립금 회수

Retrieve a list of orders

GET /api/v2/admin/orders

GET

주문을 목록으로 조회할 수 있습니다.
주문번호, 화폐단위, 회원아이디 등을 조회할 수 있습니다.
하위 리소스들을 embed 로 활용하면 한번의 호출에 필요한 정보를 더 많이 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
items embed	품주 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
receivers embed	수령자정보 리소스 조회시 Embed 파라메터를 사용하여 조회할 수 있다.
buyer embed	주문자정보 리소스
return embed	반품상세 리소스
cancellation embed	취소상세 리소스
exchange embed	교환상세 리소스
shop_no 최소값: [1]	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
start_date 날짜	검색 시작일 검색을 시작할 기준일
end_date 날짜	검색 종료일 검색을 종료할 기준일 검색 시작일과 같이 사용해야함. 검색기간은 한 호출에 3개월 이상 검색 불가.
order_id 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
order_status	주문상태 주문상태. 주문 상태별로 각각의 코드가 있음. ,(콤마)로 여러 건을 검색할 수 있다. N00 : 입금전 N10 : 상품준비중 N20 : 배송준비중 N21 : 배송대기 N22 : 배송보류 N30 : 배송중 N40 : 배송완료 N50 : 구매확정 C00 : 취소신청 C10 : 취소접수 - 관리자 C11 : 취소접수거부 - 관리자 C34 : 취소처리중 - 환불전 C35 : 취소처리중 - 환불완료 C36 : 취소처리중 - 환불보류 C40 : 취소완료 C41 : 취소 완료 - 환불전 C42 : 취소 완료 - 환불요청중 C43 : 취소 완료 - 환불보류 C47 : 입금전취소 - 구매자 C48 : 입금전취소 - 자동취소 C49 : 입금전취소 - 관리자 R00 : 반품신청 R10 : 반품접수 R11 : 반품 접수 거부 R12 : 반품보류 R13 : 반품접수 - 수거완료(자동) R20 : 반품 수거 완료 R30 : 반품처리중 - 수거전 R31 : 반품처리중 - 수거완료 R34 : 반품처리중 - 환불전 R36 : 반품처리중 - 환불보류 R40 : 반품완료 - 환불완료 R41 : 반품완료 - 환불전 R42 : 반품완료 - 환불요청중 R43 : 반품완료 - 환불보류 E00 : 교환신청 E10 : 교환접수 N01 : 교환접수 - 교환상품 E11 : 교환접수거부 E12 : 교환보류 E13 : 교환접수 - 수거완료(자동) E20 : 교환준비 E30 : 교환처리중 - 수거전 E31 : 교환처리중 - 수거완료 E32 : 교환처리중 - 입금전 E33 : 교환처리중 - 입금완료 E34 : 교환처리중 - 환불전 E35 : 교환처리중 - 환불완료 E36 : 교환처리중 - 환불보류 E40 : 교환완료 E41 : 교환 완료 - 교환철회 E50 : 교환철회 - 판매자 E51 : 교환철회 - 구매자
payment_status	결제상태 F : 입금전 M : 추가입금대기 T : 입금완료(수동) A : 입금완료(자동) P : 결제완료
member_type	회원여부 회원여부. 회원과 비회원 각각의 코드가 있음. 2 : 회원 3 : 비회원
group_no	회원등급번호
buyer_name	주문자명 주문자 이름. 입금자 혹은 수령자 이름과는 다를 수 있음.
receiver_name	수령자명 수령자 이름. 주문자 혹은 입금자 이름과는 다를 수 있음.
name_furigana	수령자명 (발음)
receiver_address	수령자주소 수령자 주소. 주문자 혹은 입금자 주소와는 다를 수 있음.
member_id	회원아이디 회원 아이디
member_email	회원 이메일
product_no	상품번호 상품 번호 ,(콤마)로 여러 건을 검색할 수 있다.
product_code	상품코드 상품 코드
date_type	검색날짜 유형 검색을 위한 날짜 유형 기준. 기본값은 주문일로 설정되어 있음. order_date : 주문일 pay_date : 결제일 shipbegin_date : 배송시작일 shipend_date : 배송완료일 cancel_date : 주문취소일 place_date : 발주일 cancel_request_date : 취소신청일 cancel_accept_date : 취소접수일 cancel_complete_date : 취소완료일 exchange_request_date : 교환신청일 exchange_accept_date : 교환접수일 exchange_complete_date : 교환완료일 return_request_date : 반품신청일 return_accept_date : 반품접수일 return_complete_date : 반품완료일 purchaseconfirmation_date : 구매확정일 DEFAULT order_date
supplier_id	공급사 아이디 ,(콤마)로 여러 건을 검색할 수 있다.
order_place_id	주문경로 ,(콤마)로 여러 건을 검색할 수 있다. cafe24:카페24 mobile:모바일웹 mobile_d:모바일앱 NCHECKOUT:네이버페이 inpark:인터파크 auction:옥션 sk11st:11번가 gmarket:G마켓 coupang:쿠팡 shopn:스마트스토어
buyer_cellphone	주문자 휴대 전화
buyer_phone	주문자 일반 전화
buyer_email	주문자 이메일
inflow_path	유입경로
subscription	정기결제 여부 T : 정기결제 F : 정기결제 아님
market_order_no 형식 : [a-zA-Z0-9_-] 최대글자수 : [40자]	마켓 주문 번호 ,(콤마)로 여러 건을 검색할 수 있다.
market_cancel_request	마켓 취소요청 여부 T : 취소 요청된 마켓 주문
payment_method	결제수단 코드 ,(콤마)로 여러 건을 검색할 수 있다. cash : 무통장 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 cell : 휴대폰 deferpay : 후불 cvs : 편의점 point : 선불금 mileage : 적립금 deposit : 예치금 giftcard : 제휴상품권 pointcard : 제휴포인트 etc : 기타
payment_gateway_name	PG 이름 ,(콤마)로 여러 건을 검색할 수 있다.
market_seller_id	마켓 판매자 아이디
discount_method	할인수단 ,(콤마)로 여러 건을 검색할 수 있다. point : 적립금 credit : 예치금 coupon : 쿠폰 market_discount : 마켓할인 discount_code : 할인코드
discount_code	할인코드
carrier_id 최소값: [1]	배송사 아이디
labels	주문 라벨 ,(콤마)로 여러 건을 검색할 수 있다.
refund_status	CS(환불)상태 ,(콤마)로 여러 건을 검색할 수 있다. F : 환불전 T : 환불완료 M : 환불보류
limit 최소: [1]~최대: [1000]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10
offset 최대값: [15000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Retrieve an order

GET /api/v2/admin/orders/{order_id}

GET

주문 1건을 조회할 수 있습니다.
주문번호, 회원아이디, 결제수단 등을 조회할 수 있습니다.
하위 리소스들을 embed 로 활용하면 한번의 호출에 필요한 정보를 더 많이 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
items embed	품주 리소스
receivers embed	수령자정보 리소스
buyer embed	주문자정보 리소스
benefits embed	혜택 리소스
coupons embed	쿠폰 리소스
return embed	반품상세 리소스
cancellation embed	취소상세 리소스
exchange embed	교환상세 리소스
refunds embed	환불상세 리소스

Request Copy

Response Copy

Retrieve a count of orders

GET /api/v2/admin/orders/count

GET

주문의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
start_date 날짜	검색 시작일 검색을 시작할 기준일
end_date 날짜	검색 종료일 검색을 종료할 기준일 검색 시작일과 같이 사용해야함. 검색기간은 한 호출에 3개월 이상 검색 불가.
order_id 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
order_status	주문상태 주문상태. 주문 상태별로 각각의 코드가 있음. ,(콤마)로 여러 건을 검색할 수 있다. N00 : 입금전 N10 : 상품준비중 N20 : 배송준비중 N21 : 배송대기 N22 : 배송보류 N30 : 배송중 N40 : 배송완료 N50 : 구매확정 C00 : 취소신청 C10 : 취소접수 - 관리자 C11 : 취소접수거부 - 관리자 C34 : 취소처리중 - 환불전 C35 : 취소처리중 - 환불완료 C36 : 취소처리중 - 환불보류 C40 : 취소완료 C41 : 취소 완료 - 환불전 C42 : 취소 완료 - 환불요청중 C43 : 취소 완료 - 환불보류 C47 : 입금전취소 - 구매자 C48 : 입금전취소 - 자동취소 C49 : 입금전취소 - 관리자 R00 : 반품신청 R10 : 반품접수 R11 : 반품 접수 거부 R12 : 반품보류 R13 : 반품접수 - 수거완료(자동) R20 : 반품 수거 완료 R30 : 반품처리중 - 수거전 R31 : 반품처리중 - 수거완료 R34 : 반품처리중 - 환불전 R36 : 반품처리중 - 환불보류 R40 : 반품완료 - 환불완료 R41 : 반품완료 - 환불전 R42 : 반품완료 - 환불요청중 R43 : 반품완료 - 환불보류 E00 : 교환신청 E10 : 교환접수 N01 : 교환접수 - 교환상품 E11 : 교환접수거부 E12 : 교환보류 E13 : 교환접수 - 수거완료(자동) E20 : 교환준비 E30 : 교환처리중 - 수거전 E31 : 교환처리중 - 수거완료 E32 : 교환처리중 - 입금전 E33 : 교환처리중 - 입금완료 E34 : 교환처리중 - 환불전 E35 : 교환처리중 - 환불완료 E36 : 교환처리중 - 환불보류 E40 : 교환완료 E41 : 교환 완료 - 교환철회 E50 : 교환철회 - 판매자 E51 : 교환철회 - 구매자
payment_status	결제상태 F : 입금전 M : 추가입금대기 T : 입금완료(수동) A : 입금완료(자동) P : 결제완료
member_type	회원여부 회원여부. 회원과 비회원 각각의 코드가 있음. 2 : 회원 3 : 비회원
group_no	회원등급번호
buyer_name	주문자명 주문자 이름. 입금자 혹은 수령자 이름과는 다를 수 있음.
receiver_name	수령자명 수령자 이름. 주문자 혹은 입금자 이름과는 다를 수 있음.
name_furigana	수령자명 (발음)
receiver_address	수령자주소 수령자 주소. 주문자 혹은 입금자 주소와는 다를 수 있음.
member_id	회원아이디 회원 아이디
member_email	회원 이메일
product_no	상품번호 상품 번호 ,(콤마)로 여러 건을 검색할 수 있다.
product_code	상품코드 검색어를 상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요)
date_type	검색날짜 유형 검색을 위한 날짜 유형 기준. 기본값은 주문일로 설정되어 있음. order_date : 주문일 pay_date : 결제일 shipbegin_date : 배송시작일 shipend_date : 배송완료일 cancel_date : 주문취소일 place_date : 발주일 cancel_request_date : 취소신청일 cancel_accept_date : 취소접수일 cancel_complete_date : 취소완료일 exchange_request_date : 교환신청일 exchange_accept_date : 교환접수일 exchange_complete_date : 교환완료일 return_request_date : 반품신청일 return_accept_date : 반품접수일 return_complete_date : 반품완료일 purchaseconfirmation_date : 구매확정일 DEFAULT order_date
supplier_id	공급사 아이디 ,(콤마)로 여러 건을 검색할 수 있다.
order_place_id	주문경로 ,(콤마)로 여러 건을 검색할 수 있다. cafe24:카페24 mobile:모바일웹 mobile_d:모바일앱 NCHECKOUT:네이버페이 inpark:인터파크 auction:옥션 sk11st:11번가 gmarket:G마켓 coupang:쿠팡 shopn:스마트스토어
buyer_cellphone	주문자 휴대 전화
buyer_phone	주문자 일반 전화
buyer_email	주문자 이메일
inflow_path	유입경로
subscription	정기결제 여부 T : 정기결제 F : 정기결제 아님
market_order_no 형식 : [a-zA-Z0-9_-] 최대글자수 : [40자]	마켓 주문 번호 ,(콤마)로 여러 건을 검색할 수 있다.
market_cancel_request	마켓 취소요청 여부 T : 취소 요청된 마켓 주문
payment_method	결제수단 코드 ,(콤마)로 여러 건을 검색할 수 있다. cash : 무통장 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 cell : 휴대폰 deferpay : 후불 cvs : 편의점 point : 선불금 mileage : 적립금 deposit : 예치금 giftcard : 제휴상품권 pointcard : 제휴포인트 etc : 기타
payment_gateway_name	PG 이름 ,(콤마)로 여러 건을 검색할 수 있다.
market_seller_id	마켓 판매자 아이디
discount_method	할인수단 ,(콤마)로 여러 건을 검색할 수 있다. point : 적립금 credit : 예치금 coupon : 쿠폰 market_discount : 마켓할인 discount_code : 할인코드
discount_code	할인코드
carrier_id 최소값: [1]	배송사 아이디
labels	주문 라벨 ,(콤마)로 여러 건을 검색할 수 있다.
refund_status	CS(환불)상태 ,(콤마)로 여러 건을 검색할 수 있다. F : 환불전 T : 환불완료 M : 환불보류

Request Copy

Response Copy

Update status for multiple orders

PUT /api/v2/admin/orders

PUT

여러건의 주문의 주문상태를 수정할 수 있습니다.
구매자나 수령자의 정보를 수정하기 위해서는 Orders buyer, Orders receivers 를 확인해주세요.
주문의 배송처리는 Orders shipments 를 확인해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
process_status	주문상태 prepare : 배송준비중 prepareproduct : 상품준비중 hold : 배송보류 unhold : 배송보류해제
order_item_code	품주코드
purchase_confirmation	구매확정 여부 T : 구매확정 F : 구매확정 철회
collect_points	적립금 회수 T: 회수 F: 회수안함 DEFAULT F
show_shipping_address	배송지 정보 표기 여부 T: 배송지 정보 표기 F: 배송지 정보 가림

Request Copy

Response Copy

Update an order status

PUT /api/v2/admin/orders/{order_id}

PUT

주문 1건의 주문상태를 수정할 수 있습니다.
구매자나 수령자의 정보를 수정하기 위해서는 Orders buyer, Orders receivers 를 확인해주세요.
주문의 배송처리는 Orders shipments 를 확인해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
process_status	주문상태 prepare : 배송준비중 prepareproduct : 상품준비중 hold : 배송보류 unhold : 배송보류해제
order_item_code	품주코드
purchase_confirmation	구매확정 여부 T : 구매확정 F : 구매확정 철회
collect_points	적립금 회수 T: 회수 F: 회수안함 DEFAULT F
show_shipping_address	배송지 정보 표기 여부 T: 배송지 정보 표기 F: 배송지 정보 가림

Request Copy

Response Copy

Orders autocalculation

자동금액 계산(autocalculation)은 취소/교환/반품시 할인 금액 등 주문 단위의 금액을 자동으로 배분해주는 기능입니다.
해당 리소스에서는 특정 주문에 대해 자동금액 계산을 해제할 수 있습니다.

Endpoints

DELETE /api/v2/admin/orders/{order_id}/autocalculation

Orders autocalculation properties

Attribute

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id

주문번호

Remove auto calculation setting of an order

DELETE /api/v2/admin/orders/{order_id}/autocalculation

DELETE

특정 주문에 자동금액 계산을 해제하여 취소/교환/반품이 가능하도록 할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Request Copy

Response Copy

Orders benefits

주문혜택(Orders benefits)은 특정 주문에 적용된 혜택에 관한 기능입니다.

Endpoints

GET /api/v2/admin/orders/benefits

Orders benefits properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
order_item_code	품주코드
benefit_no	혜택번호
benefit_title	혜택 유형
benefit_name	혜택명
benefit_code	혜택코드
benefit_percent	혜택 비율
benefit_value	혜택 금액
benefit_app_key	앱 클라이언트 ID

Retrieve a list of order benefits applied to an order

GET /api/v2/admin/orders/benefits

GET

특정 주문에 적용된 혜택을 목록으로 조회할 수 있습니다.
혜택코드, 혜택비율, 혜택금액 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
limit 최소: [1]~최대: [500]	조회결과 최대건수 DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Orders buyer

주문자(Buyer)는 쇼핑몰의 상품을 주문한 사람을 나타냅니다.
주문자 리소스를 통해 특정 주문의 주문자의 이름, 주소, 전화번호, 이메일 등의 정보를 조회하거나 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/buyer
PUT /api/v2/admin/orders/{order_id}/buyer

Orders buyer properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
member_id	회원아이디
member_group_no	주문당시 주문자 회원 등급 번호
name	주문자명
names_furigana	주문자 이름 후리가나
email	주문자 이메일 해당 회원의 이메일
phone	주문자 일반 전화
cellphone	주문자 휴대 전화
customer_notification	고객 알림 고객에게 알릴 문구
updated_date	수정일
user_id	주문자 수정자 ID 주문자정보를 수정한 사람의 ID
user_name	주문자 수정자 명 주문자정보를 수정한 사람의 이름
company_name	상호명
company_registration_no	사업자등록번호
buyer_zipcode	주문자 우편번호
buyer_address1	주문자 기본주소
buyer_address2	주문자 상세주소
order_id 주문번호	주문번호

Retrieve customer details of an order

GET /api/v2/admin/orders/{order_id}/buyer

GET

특정 주문의 주문자 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Request Copy

Response Copy

Update customer information of an order

PUT /api/v2/admin/orders/{order_id}/buyer

PUT

특정 주문의 주문자 정보를 수정할 수 있습니다.
주문자명, 주문자 휴대 전화 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
order_id Required 주문번호	주문번호
name	주문자명
email 이메일	주문자 이메일 해당 회원의 이메일
phone	주문자 일반 전화
cellphone	주문자 휴대 전화
customer_notification	고객 알림 고객에게 알릴 문구

Request Copy

Response Copy

Orders buyer history

주문자 수정 이력(Buyer History)은 특정 주문의 주문자 정보가 수정된 이력을 나타냅니다.
주문자 정보가 수정될 때마다 이력이 추가됩니다.
주문자 수정 이력 리소스를 통해 특정 주문의 주문자 정보가 수정된 내역을 확인할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/buyer/history

Orders buyer history properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
name	주문자명
email 이메일	주문자 이메일
phone	주문자 일반 전화
cellphone	주문자 휴대 전화
customer_notification	고객 알림
updated_date	수정일
user_id	주문자 수정자 ID
user_name	주문자 수정자 명

Retrieve a list of customer history of an order

GET /api/v2/admin/orders/{order_id}/buyer/history

GET

특정 주문의 주문자 수정 이력을 조회할 수 있습니다.
주문자명, 주문자 이메일, 휴대전화 정보등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Request Copy

Response Copy

Orders calculation

주문의 결제예정금액 계산(Orders calculation)은 주문의 배송국가 등을 체크하여 결제예정금액을 계산하는 기능입니다.

Endpoints

POST /api/v2/admin/orders/calculation

Orders calculation properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
mobile	모바일 PC 여부
member_id	회원아이디
shipping_type	배송 유형 A : 국내 B : 해외
payment_method	결제수단 코드 cash : 무통장 card : 신용카드 icash : 가상계좌 tcash : 계좌이체 cell : 휴대폰 deferpay : 후불결제 point : 적립금
country_code	국가코드
carrier_id	배송사 아이디
zipcode	우편번호
address_full	전체주소
address_state	주/도
items	주문상품목록
membership_discount_amount	회원등급 할인금액
shipping_fee_discount_amount	배송비 할인금액
product_discount_amount	상품별 할인금액
order_price_amount	상품 구매금액
total_discount_amount	총 할인금액
shipping_fee	배송비
total_amount_due	결제예정 금액
shipping_fee_information	배송비 상세정보

Calculate total due

POST /api/v2/admin/orders/calculation

POST

주문의 결제예정금액 계산 처리를 할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
mobile	모바일 PC 여부 T : 사용함 F : 사용안함 DEFAULT F
member_id 최대글자수 : [20자]	회원아이디
shipping_type	배송 유형 A : 국내 B : 해외 DEFAULT A
payment_method	결제수단 코드 cash : 무통장 card : 신용카드 icash : 가상계좌 tcash : 계좌이체 cell : 휴대폰 deferpay : 후불결제 point : 적립금
country_code	국가코드
carrier_id	배송사 아이디
zipcode	우편번호
address_full 최대글자수 : [1000자]	전체주소
address_state 최대글자수 : [255자]	주/도
items	주문상품목록
product_no Required 상품번호 variant_code Required 상품 품목 코드 quantity Required 수량 product_price Required 상품 판매가 option_price 옵션 추가 가격 product_bundle 세트상품 여부 T : 세트상품 F : 세트상품 아님 DEFAULT F product_bundle_no 세트상품번호 prepaid_shipping_fee 배송비 선결제 설정 P : 선불 C : 착불 DEFAULT P

Request Copy

Response Copy

Orders cancellation

주문 취소(Orders cancellation) 는 배송 전의 특정 주문 하나를 취소 처리할 수 있는 기능입니다.
해당 API를 사용하여 취소완료처리할 경우 환불완료 처리와 함께 PG 취소도 같이 진행할 수 있습니다.(payment_gateway_cancel : "T"로 요청시)

Endpoints

POST /api/v2/admin/orders/{order_id}/cancellation
PUT /api/v2/admin/orders/{order_id}/cancellation/{claim_code}

Orders cancellation properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
status	주문상태 canceled : 취소완료 canceling : 취소처리중
claim_code	취소번호
items	품주코드
recover_inventory	재고복구 T : 복구함 F : 복구안함
undone	철회 여부 T : 철회함 F : 철회안함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason	주문상세내역 노출 철회 사유

Create an order cancellation

POST /api/v2/admin/orders/{order_id}/cancellation

POST

배송 전의 특정 주문을 취소할 수 있습니다.
해당 API를 사용하여 취소할 경우 환불완료 처리와 함께 PG취소도 같이 진행할 수 있습니다.
부분취소할 경우 각 환불 금액은 자동 계산되어 환불처리 됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
payment_gateway_cancel	PG 취소 요청 여부 주문을 취소함과 동시에 PG취소도 같이 처리할 수 있다. PG취소가 가능한 결제수단(신용카드, 실시간계좌이체)에서만 사용 가능하다. 결제수단이 복수인 주문(카드 등으로 결제한 주문을 결제 후 품목을 추가한 경우)의 경우에는 PG 결제를 취소할 수 없으며 관리자 화면에서 취소해야 한다. 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가 T : 취소함 F : 취소안함 DEFAULT F
status Required	주문상태 canceled : 취소완료 canceling : 취소처리중
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon_no	복원할 쿠폰 번호
add_memo_too	관리자 메모에도 추가 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	취소사유
claim_reason_type	취소사유 구분 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_cancel_reason_type	네이버페이 취소사유 구분 쇼핑몰/오픈마켓/카카오페이 주문을 취소할 경우 사용 불가 EC 베트남, 필리핀 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 60 : 상품 정보 상이
kakaopay_cancel_reason_type	카카오페이 취소사유 구분 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 K1 : 변심에 의한 상품 취소 K2 : 다른 옵션이나 상품을 잘못 주문함 K3 : 배송지연 K4 : 상품 파손 또는 불량 K5 : 다른 상품 오배송 또는 구성품 누락 K6 : 상품정보와 다름 K7 : 품절로 인한 배송 불가
refund_method_code	환불 방식 (오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가) T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 J : 제휴상품권 K : 제휴포인트 I : 기타
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가
refund_bank_name 최대글자수 : [250자]	환불은행명 환불 방식(refund_method)이 현금(T)일 경우 필수 ※ 해당 쇼핑몰이 EC Global 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가
refund_bank_account_no	환불 계좌번호 환불 방식(refund_method)이 현금(T)일 경우 필수 오픈마켓/네이버페이/카카오페이 주문을 취소할 경우 사용 불가
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code Required 품주코드 quantity Required 수량

Request Copy

Response Copy

Change cancellation details

PUT /api/v2/admin/orders/{order_id}/cancellation/{claim_code}

PUT

주문의 취소접수를 철회할 수 있습니다.
취소가 접수된 주문의 주문상태를 취소접수 이전의 상태로 수정할 수 있습니다.
주문의 취소접수를 철회를 통해 취소접수를 철회하고 재고를 복구하거나 철회사유를 입력할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
claim_code Required	취소번호
recover_inventory Required	재고복구 T : 복구함 F : 복구안함
undone Required	철회 여부 T : 철회함
add_memo_too Required	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type Required	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason 최대글자수 : [2000자]	철회 사유
expose_order_detail Required	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason 최대글자수 : [2000자]	주문상세내역 노출 철회 사유

Request Copy

Response Copy

Orders coupons

주문 쿠폰(Orders coupons)은 주문에 적용된 쿠폰에 관한 기능입니다.
특정 주문에 대해 적용된 쿠폰의 정보를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/coupons

Orders coupons properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
order_item_code	품주코드
coupon_name	쿠폰명
coupon_code	쿠폰번호
coupon_percent	쿠폰 비율
coupon_value	쿠폰 금액
coupon_value_final	최종 쿠폰 금액

Retrieve a list of coupons applied to an order

GET /api/v2/admin/orders/coupons

GET

특정 주문에 대해 적용된 쿠폰의 정보를 목록으로 조회할 수 있습니다.
쿠폰번호, 쿠폰비율, 쿠폰금액 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
limit 최소: [1]~최대: [500]	조회결과 최대건수 DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Orders exchange

주문 교환(Orders exchange)은 주문의 교환 접수 상태와 관련된 기능입니다.
특정 주문에 대해 교환 접수를 할 수 있으며 교환이 접수된 주문의 상태를 수정할 수 있습니다.

Endpoints

POST /api/v2/admin/orders/{order_id}/exchange
PUT /api/v2/admin/orders/{order_id}/exchange/{claim_code}

Orders exchange properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
status	주문상태 accept : 접수 collected : 수거완료 exchanged : 교환완료
claim_code	교환번호
items	품주코드
exchanged_items	교환상품
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name 최대글자수 : [30자]	반품 배송업체명
recover_inventory	재고복구 T : 복구함 F : 복구안함
exchanged_after_collected	수거완료시 교환완료 여부 T : 사용함 F : 사용안함
request_pickup	수거신청 여부 T : 사용함 F : 사용안함
pickup	수거지역 상세
undone	철회 여부 T : 철회함 F : 철회안함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason	주문상세내역 노출 철회 사유
carrier_id	배송사 아이디
return_invoice_success	반송장 처리 성공 여부 T : 성공 F : 실패 N : 미집하
return_invoice_fail_reason 최대글자수 : [100자]	반송장 처리 실패 사유

Create an order exchange

POST /api/v2/admin/orders/{order_id}/exchange

POST

주문을 교환 접수 처리합니다.
동일상품교환 여부와 재고복구 상태를 입력할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
status Required	주문상태 accepted : 교환접수 exchanged : 교환완료
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함 DEFAULT F
items	품주코드
order_item_code Required 품주코드 quantity Required 수량 exchange_variant_code (동일상품 다른 옵션 교환시) 교환 상품 품목 코드
same_product Required	동일상품교환 여부 T : 동일상품교환 F : 다른상품교환

Request Copy

Response Copy

Update an order exchange

PUT /api/v2/admin/orders/{order_id}/exchange/{claim_code}

PUT

교환이 접수된 주문의 상태를 수정할 수 있습니다.
단건의 주문에 대해 교환접수를 철회하고 재고를 복구하거나 철회사유를 입력할 수 있습니다.
택배사에 이미 수거요청이 전달되었으나 수거가 필요하지 않게 될 경우, 택배사에 직접 연락하셔서 수거요청을 취소해주셔야 합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
claim_code Required	교환번호
status	주문상태 exchanged : 교환완료
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name 최대글자수 : [30자]	반품 배송업체명
recover_inventory	재고복구 T : 복구함 F : 복구안함
exchanged_after_collected	수거완료시 교환완료 여부 T : 사용함 F : 사용안함
items	품주코드
order_item_code 품주코드
request_pickup	수거신청 여부 T : 사용함 F : 사용안함
pickup	수거지역 상세
name 이름 phone 전화번호 cellphone 휴대전화 zipcode 우편번호 address1 기본 주소 address2 상세 주소
undone	철회 여부 T : 철회함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason 최대글자수 : [2000자]	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason 최대글자수 : [2000자]	주문상세내역 노출 철회 사유
carrier_id	배송사 아이디
return_invoice_success	반송장 처리 성공 여부 T : 성공 F : 실패 N : 미집하
return_invoice_fail_reason 최대글자수 : [100자]	반송장 처리 실패 사유

Request Copy

Response Copy

Orders exchangerequests

교환 처리를 요청한 주문의 교환접수를 거부할 수 있습니다.

Endpoints

PUT /api/v2/admin/orders/{order_id}/exchangerequests

Orders exchangerequests properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
undone	접수거부 여부
order_item_code	품주코드
additional_payment_gateway_cancel	추가 PG 취소

Reject an exchange request

PUT /api/v2/admin/orders/{order_id}/exchangerequests

PUT

교환 처리를 요청한 주문의 교환 접수를 거부합니다.
교환신청번호, 거부 사유 등을 필수로 입력합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
order_item_code Required	품주코드
undone Required	접수거부 여부 T : 접수거부함
reason_type	사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
reason 최대글자수 : [2000자]	사유
display_reject_reason	주문상세내역 노출설정 T : 노출함 F : 노출안함 DEFAULT F
reject_reason 최대글자수 : [2000자]	거부 사유 고객에게 노출되는 접수 거부 사유

Request Copy

Response Copy

Orders inflowgroups

유입경로 그룹(Inflowgroups)은 주문이 유입된 경로의 그룹을 의미합니다.
유입경로 그룹은 하위 리소스로 주문(Orders) 하위에서만 사용할 수 있습니다.
유입경로 그룹에 대한 조회, 생성, 수정, 삭제가 가능합니다.

Endpoints

GET /api/v2/admin/orders/inflowgroups
POST /api/v2/admin/orders/inflowgroups
PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}
DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

Orders inflowgroups properties

Attribute	Description
inflow_group_id	유입경로 그룹 아이디
inflow_group_name	유입경로 그룹 이름

Retrieve a list of traffic source groups

GET /api/v2/admin/orders/inflowgroups

GET

유입경로 그룹 목록을 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

Request Copy

Response Copy

Create a traffic source group

POST /api/v2/admin/orders/inflowgroups

POST

유입경로 그룹을 생성할 수 있습니다.
유입경로 이름과 유입경로 아이디는 필수값입니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
inflow_group_id Required 최대글자수 : [40자] 형식 : [a-zA-Z0-9]	유입경로 그룹 아이디
inflow_group_name Required 최대글자수 : [100자]	유입경로 그룹 이름

Request Copy

Response Copy

Update a traffic source group

PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}

PUT

유입경로 그룹을 수정할 수 있습니다.
유입경로 그룹 아이디, 그룹 멤버 이름 등을 필수로 입력합니다.
유입경로 그룹을 등록하면 같은 유입경로에 대해 그룹화하여 쉽게 알아볼 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
inflow_group_id Required 형식 : [a-zA-Z0-9] 최대글자수 : [40자]	유입경로 그룹 아이디
inflow_group_name Required 최대글자수 : [100자]	유입경로 그룹 이름

Request Copy

Response Copy

Delete a traffic source group

DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

DELETE

유입경로 그룹을 삭제할 수 있습니다.
삭제할 때에는 유입경로 그룹의 아이디 멤버 아이디를 모두 입력해주셔야 합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter	Description
inflow_group_id Required 최대글자수 : [40자] 형식 : [a-zA-Z0-9]	유입경로 그룹 아이디

Request Copy

Response Copy

Orders inflowgroups inflows

유입경로 그룹(Inflowgroups)은 주문이 유입된 경로의 그룹을 의미합니다.
유입경로 그룹은 하위 리소스로 주문(Orders) 하위에서만 사용할 수 있습니다.
유입경로 그룹에 대한 조회, 생성, 수정, 삭제가 가능합니다.

Endpoints

GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows
POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows
PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}
DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

Orders inflowgroups inflows properties

Attribute	Description
inflow_id	유입경로 그룹 멤버 아이디
inflow_name	유입경로 그룹 멤버 이름
inflow_icon	유입경로 아이콘
group_id	유입경로 그룹 아이디

Retrieve a list of group traffic sources

GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows

GET

특정 유입경로 그룹 내에 속한 유입경로의 목록을 조회할 수 있습니다.
유입경로 그룹 멤버 이름, 유입경로 아이콘, 유입경로 그룹 아이디를 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
group_id Required 최대글자수 : [40자]	유입경로 그룹 아이디

Request Copy

Response Copy

Create a group traffic source

POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows

POST

특정 유입경로 그룹 내에 속한 유입경로를 생성할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
group_id Required 최대글자수 : [40자]	유입경로 그룹 아이디
inflow_id Required 최대글자수 : [40자]	유입경로 그룹 멤버 아이디
inflow_name Required 최대글자수 : [100자]	유입경로 그룹 멤버 이름
inflow_icon Required URL 최대글자수 : [500자]	유입경로 아이콘

Request Copy

Response Copy

Update a group traffic source

PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

PUT

특정 유입경로 그룹 내에 속한 유입경로를 수정할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
group_id Required 최대글자수 : [40자]	유입경로 그룹 아이디
inflow_id Required 최대글자수 : [40자]	유입경로 그룹 멤버 아이디
inflow_name Required 최대글자수 : [100자]	유입경로 그룹 멤버 이름
inflow_icon Required URL 최대글자수 : [500자]	유입경로 아이콘

Request Copy

Response Copy

Delete a group traffic source

DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

DELETE

특정 유입경로 그룹 내에 속한 유입경로를 삭제할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter	Description
group_id Required 최대글자수 : [40자]	유입경로 그룹 아이디
inflow_id Required 최대글자수 : [40자]	유입경로 그룹 멤버 아이디

Request Copy

Response Copy

Orders items

품주(Items)는 쇼핑몰 고객이 주문할 때 구매한 품목 정보입니다.
쇼핑몰의 품목은 쇼핑몰에서 판매하는 상품의 기본 단위로, 품주에는 구입한 상품의 품목 정보와 더불어, 구매시 선택한 옵션, 주문 수량 등의 정보를 추가로 확인할 수 있습니다.
품주는 하위 리소스로서 주문(Order) 하위에서만 사용할 수 있습니다.
품주의 조회와 상태변경, 취소/교환/반품 요청 사유 등의 입력과 수정이 가능합니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/items
POST /api/v2/admin/orders/{order_id}/items
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

Orders items properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
item_no	품주 아이디 품목별 주문번호의 아이디
order_item_code	품주코드 품목별 주문번호의 코드
variant_code	품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.
product_code	상품코드 시스템이 상품에 부여한 코드. 해당 쇼핑몰 내에서 상품코드는 중복되지 않음.
internal_product_name	상품명(관리용)
custom_product_code 최대글자수 : [40자]	자체상품 코드
custom_variant_code	자체 품목 코드
eng_product_name	영문 상품명 상품의 영문 이름. 해외 배송 등에 사용 가능함.
option_id	상품옵션 아이디 상품옵션의 아이디
option_value	옵션값 주문한 상품의 옵션값
option_value_default	기본옵션값
additional_option_value	추가입력 옵션 값
additional_option_values	추가입력 옵션 목록
product_name	상품명 상품의 이름. 상품명은 상품을 구분하는 가장 기초적인 정보이며 검색 정보가 됨.
product_name_default	기본 상품명
product_price	상품 판매가 상품의 판매가. 멀티쇼핑몰 운영 시에는 판매가를 쇼핑별 화폐단위로 환산하여 보여줌.
option_price	옵션 추가 가격 옵션별로 해당하는 추가 가격이 있을 경우 그 추가가격.
additional_discount_price	상품추가할인액 상품에 대한 추가 할인금액
coupon_discount_price	상품별 쿠폰 할인금액
app_item_discount_amount	앱 상품할인금액
payment_amount	품목별 결제금액
quantity	수량 주문한 상품의 수량
product_tax_type	상품 세금 구분 A : 과세 B : 면세 C : 비과세
tax_rate	과세율
supplier_product_name	공급사 상품명 공급사의 상품명
supplier_transaction_type	공급사 거래 유형 공급사의 거래 유형 D: 직등록형 P: 수수료형
supplier_id	공급사 아이디 공급사의 아이디
supplier_name	공급사명 공급사의 이름
tracking_no	송장번호
shipping_code	배송번호 배송번호. 품목별 주문번호를 배송준비중으로 처리하면 시스템이 자동으로 부여하는 번호.
claim_code	취소/교환/반품 번호
claim_reason_type	취소/교환/반품 요청 사유 타입 구매자의 취소/교환/반품 신청 사유 구분. 판매자의 접수 사유는 각 취소/교환/반품 리소스의 claim_reason_type으로 조회할 수 있다. 구매자 취소 신청 A:고객변심 G:서비스불만족 B:배송지연 I:기타 구매자 교환/반품 신청 O:고객변심 P:상품 불만족 V:상품불량 W:배송오류 판매자 취소/교환/반품 신청 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	취소/교환/반품 요청 사유 구매자의 취소/교환/반품 신청 사유 상세 내용. 판매자의 접수 사유는 각 취소/교환/반품 리소스의 claim_reason으로 조회할 수 있다.
refund_bank_name	환불은행명
refund_bank_account_no	환불 계좌번호
refund_bank_account_holder	환불계좌 예금주 명의
post_express_flag	우체국 택배연동 우체국 택배연동 상태
order_status	주문상태 주문상태. 주문 상태별로 각각의 코드가 있음.
request_undone	철회상태 Cancellation : 취소철회 Exchange : 교환철회 Return : 반품철회
order_status_additional_info	주문상태 추가정보 주문상태의 추가정보
claim_quantity	취소/교환/반품 요청 수량
status_code	현재 처리상태 코드 현재 처리상태의 코드 N1 : 정상 N2 : 교환상품 C1 : 입금전취소 C2 : 배송전취소 C3 : 반품 E1 : 교환
status_text	현재 처리상태 현재 처리상태 문구설명
open_market_status	마켓연동 상태값
bundled_shipping_type	묶음배송 타입 배송 대상 주문건의 묶음배송 유형 N : 단일 주문 일반 배송(Normal) C :복합 주문 결합 배송(Combination)
shipping_company_id	배송업체 아이디 배송업체의 아이디
shipping_company_name	배송업체 이름 배송업체의 이름
shipping_company_code	배송업체 코드 shipping_company_code
product_bundle	세트상품 여부 T : 세트상품 F : 세트상품 아님
product_bundle_no	세트상품번호 분리형 세트상품의 번호 일체형 세트 상품의 번호는 product_no에서 표시됨.
product_bundle_name	세트상품명 분리형 세트상품의 이름 일체형 세트 상품의 이름은 product_name에서 표시됨
product_bundle_name_default	세트상품명(기본) 분리형 세트상품의 이름 일체형 세트 상품의 이름은 product_name에서 표시됨
product_bundle_type	세트상품 타입 세트상품의 타입 C : 일체형 S : 분리형
was_product_bundle	세트품주 분리여부 세트상품의 품목주문번호 분리 여부 T : 분리되었던 적이 있음
original_bundle_item_no	분리된 세트상품의 기존 품주번호 분리형 세트 상품의 기존 품목 번호
naver_pay_order_id	네이버페이 상품별 주문번호 네이버페이 주문의 상품별 주문번호
naver_pay_claim_status	네이버페이 클레임 타입 네이버페이 주문의 클레임 타입 PAYMENT_WAITING : 입금대기 PAYED : 결제완료 DELIVERING : 배송중 DELIVERED : 배송완료 PURCHASE_DECIDED : 구매확정 EXCHANGED : 교환 CANCELED : 취소 RETURNED : 반품 CANCELED_BY_NOPAYMENT : 미입금취소 NOT_YET : 발주 미확인 OK : 발주 확인 CANCEL : 발주 확인 해제 CANCEL_REQUEST : 취소요청 CANCELING : 취소처리중 CANCEL_DONE : 취소처리완료 CANCEL_REJECT : 취소철회 RETURN_REQUEST : 반품요청 COLLECTING : 수거처리중 COLLECT_DONE : 수거완료 RETURN_DONE : 반품완료 RETURN_REJECT : 반품철회 EXCHANGE_REQUEST : 교환요청 COLLECTING : 수거처리중 COLLECT_DONE : 수거완료 EXCHANGE_REDELIVERING : 교환 재배송 중 EXCHANGE_DONE : 교환완료 EXCHANGE_REJECT : 교환거부 PURCHASE_DECISION_HOLDBACK : 구매 확정 보류 PURCHASE_DECISION_HOLDBACK_REDELIVERING : 구매 확정 보류 재배송 중 PURCHASE_DECISION_REQUEST : 구매 확정 요청 PURCHASE_DECISION_HOLDBACK_RELEASE : 구매 확정 보류 해제 ADMIN_CANCELING : 직권 취소 중 ADMIN_CANCEL_DONE : 직권 취소 완료
individual_shipping_fee	개별배송비 개별 배송비
shipping_fee_type	배송비 타입 (개별배송비를 사용할 경우) 상품의 배송비 타입. shipping_calculation이 A(자동계산)일 경우 null로 반환. T : 무료 F : 착불 D : 차등(금액) M : 조건(금액) I : 고정 N : 비례(수량) W : 차등(무게) C : 차등(수량) X : 기본배송
shipping_fee_type_text	배송비타입 배송비 타입 설명
shipping_payment_option	선/착불 구분 C : 착불 P : 선결제 F : 무료
payment_info_id	결제정보 아이디
original_item_no	기존 품주 아이디
store_pickup	매장수령여부 매장수령 상품 여부 T : 매장수령 F : 매장수령 아님
ordered_date	주문일
shipped_date	배송시작일 배송 시작일
delivered_date	배송완료일 배송 완료일
purchaseconfirmation_date	구매확정일
cancel_date	주문취소일 주문 취소일
return_confirmed_date	반품승인일시
return_request_date	반품요청일 반품 요청일
return_collected_date	반품수거일
cancel_request_date	취소요청일 주문취소 요청일
refund_date	환불완료일 환불 완료일
exchange_request_date	교환요청일 교환 요청일
exchange_date	교환완료일 교환 완료일
product_material	상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)
product_material_eng	영문 상품 소재 상품소재 영문 설명
cloth_fabric	옷감 상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음.
product_weight	상품 중량 상품의 전체 중량(kg). 배송을 위해 상품 자체의 무게와 박스 무게, 포장무게를 모두 포함한 중량 기재가 필요하다.
volume_size	상품 부피 상품의 부피
volume_size_weight	상품 부피 무게 상품의 부피 무게
clearance_category	해외통관용 상품구분
clearance_category_info	해외통관용 상품정보
clearance_category_code	해외통관코드 clearance_category_code
hs_code	HS코드 통관을 위한 hs 코드
one_plus_n_event	1+N이벤트 여부 1개 구매시 N개 증정하는 이벤트 여부
origin_place	원산지정보 상품의 원산지
origin_place_no	원산지 코드
made_in_code	원산지 국가코드
origin_place_value	원산지기타정보
gift	사은품 여부 상품이 사은품인지 여부 T : 사은품 F : 사은품 아님
item_granting_gift	사은품증정 조건품주목록
subscription	정기결제 여부 T : 정기결제 F : 정기결제 아님
product_bundle_list	세트상품 목록
market_cancel_request	마켓 취소요청 여부 T : 취소 요청된 마켓 주문 F : 취소 요청되지 않은 마켓 주문
market_cancel_request_quantity	마켓 취소신청 수량
market_fail_reason	마켓 실패사유
market_fail_reason_guide	마켓 실패사유 가이드
market_item_no	외부 품목별 번호
market_custom_variant_code	마켓 자체 품목 코드
option_type	옵션 구성방식 T : 조합형 E : 연동형 F : 독립형
options	옵션
market_discount_amount	상품별 마켓 할인금액
labels	주문 라벨
order_status_before_cs	CS 전 주문상태
supply_price	상품 공급가
order_id	주문번호
claim_type	취소/교환/반품 타입
claim_status	취소/교환/반품 요청 상태

Retrieve a list of order items

GET /api/v2/admin/orders/{order_id}/items

GET

주문의 모든 품주를 조회할 수 있습니다.
품주코드, 상품번호, 자체 품목 코드 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

order_id
Required

주문번호

주문번호

supplier_id

공급사 아이디

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Create an order item

POST /api/v2/admin/orders/{order_id}/items

POST

특정 주문의 세트 품주를 나눔처리할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
was_product_bundle	세트품주 분리여부 T : 세트상품 나눔 F : 세트상품 나눔 안함 DEFAULT F
original_bundle_item_no	분리된 세트상품의 기존 품주번호
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드

Request Copy

Response Copy

Update an order item

PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

PUT

주문의 품주 1개에 대한 주문상태를 수정할 수 있습니다.
품주를 취소/교환/반품으로 상태를 변경하고 사유를 입력할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
order_item_code Required	품주코드
claim_type Required	취소/교환/반품 타입 C:취소 R:반품
claim_status Required	취소/교환/반품 요청 상태 T : 신청함 F : 신청안함
claim_reason_type Required	취소/교환/반품 요청 사유 타입 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	취소/교환/반품 요청 사유
claim_quantity	취소/교환/반품 요청 수량

Request Copy

Response Copy

Orders items labels

원하는 주문 품목에 라벨을 남기거나 조회, 수정, 삭제할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels
POST /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels
DELETE /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels/{name}

Orders items labels properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
names	주문 라벨명
order_id	주문번호
order_item_code	품주코드
name	주문 라벨명

Retrieve an order label

GET /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels

GET

특정 주문 품목의 라벨목록을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

order_item_code
Required

품주코드

Request Copy

Response Copy

Create an order label

POST /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels

POST

특정 주문 품목에 라벨을 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
order_item_code Required	품주코드
names Required	주문 라벨명

Request Copy

Response Copy

Update an order label

PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels

PUT

특정 주문 품목에 등록된 라벨을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
order_item_code Required	품주코드
names Required	주문 라벨명

Request Copy

Response Copy

Delete an order label

DELETE /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels/{name}

DELETE

특정 주문 품목에 등록된 라벨을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
order_item_code Required	품주코드
name Required	주문 라벨명

Request Copy

Response Copy

Orders items options

주문 품목에 추가입력 옵션을 둥록, 수정, 삭제할 수 있습니다.

Endpoints

POST /api/v2/admin/orders/{order_id}/items/{order_item_code}/options
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}/options
DELETE /api/v2/admin/orders/{order_id}/items/{order_item_code}/options

Orders items options properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
order_item_code	품주코드
product_bundle	세트상품 여부
additional_options	추가입력 옵션
bundle_additional_options	세트상품 추가입력 옵션

Create order item options

POST /api/v2/admin/orders/{order_id}/items/{order_item_code}/options

POST

특정 주문 품목에 추가입력 옵션을 둥록할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
order_item_code Required	품주코드
product_bundle Required	세트상품 여부
additional_options	추가입력 옵션
additional_option_name Required 추가입력옵션명 additional_option_value Required 추가입력 옵션 값
bundle_additional_options	세트상품 추가입력 옵션
variant_code Required 품목코드 additional_options Array additional_option_name 추가입력옵션명 additional_option_value 추가입력 옵션 값

Request Copy

Response Copy

Edit order item options

PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}/options

PUT

특정 주문 품목에 추가입력 옵션을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
order_item_code Required	품주코드
additional_options	추가입력 옵션
additional_option_name Required 추가입력옵션명 additional_option_value Required 추가입력 옵션 값

Request Copy

Response Copy

Delete order item options

DELETE /api/v2/admin/orders/{order_id}/items/{order_item_code}/options

DELETE

특정 주문 품목에 추가입력 옵션을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter	Description
order_id Required 주문번호	주문번호
order_item_code Required	품주코드

Request Copy

Response Copy

Orders memos

주문 메모(Orders memos)는 특정 주문의 메모에 대한 주문의 하위 리소스 입니다.
주문에 대하여 관리자 메모의 조회, 등록, 수정, 삭제를 할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/memos
GET /api/v2/admin/orders/{order_id}/memos
POST /api/v2/admin/orders/{order_id}/memos
PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}
DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

Orders memos properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
memo_no	메모 번호
order_id	주문번호
created_date	메모 등록일
author_id	작성자 아이디
ip	작성자 아이피
use_customer_inquiry	고객상담 동시등록 여부 T : 사용함 F : 사용안함
attach_type	등록기준 O : 주문별 P : 품목별
content	메모 내용
starred_memo	중요 메모 여부 T : 중요 메모 F : 일반 메모
fixed	상단고정 여부 T : 사용함 F : 사용안함
product_list	상품 목록
topic_type	상담분류 cs_01 : 배송문의 cs_02 : 상품문의 cs_03 : 결제문의 cs_04 : 주문취소 cs_05 : 상품변경
status	상담결과 F : 처리중 T : 처리완료

Retrieve a list of admin memos for an order

GET /api/v2/admin/orders/memos

GET

여러개의 주문에 대한 메모를 목록으로 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
limit 최소: [1]~최대: [500]	조회결과 최대건수 DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Retrieve a list of order memos

GET /api/v2/admin/orders/{order_id}/memos

GET

특정주문에 대한 메모를 목록으로 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Request Copy

Response Copy

Create an order memo

POST /api/v2/admin/orders/{order_id}/memos

POST

특정 주문에 메모를 등록할 수 있습니다.
메모를 등록하면서 중요메모로 표시하거나 주문서 상단에 고정할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
content Required 최대글자수 : [1000자]	메모 내용
use_customer_inquiry	고객상담 동시등록 여부 T : 사용함 F : 사용안함 DEFAULT F
topic_type	상담분류 cs_01 : 배송문의 cs_02 : 상품문의 cs_03 : 결제문의 cs_04 : 주문취소 cs_05 : 상품변경
status	상담결과 F : 처리중 T : 처리완료
attach_type	등록기준 O : 주문별 P : 품목별 DEFAULT O
starred_memo	중요 메모 여부 T : 중요 메모 F : 일반 메모 DEFAULT F
fixed	상단고정 여부 T : 사용함 F : 사용안함 DEFAULT F
product_list	상품 목록

Request Copy

Response Copy

Update an order memo

PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}

PUT

특정 주문에 대한 메모를 수정할 수 있습니다.
메모내용, 상담분류, 중요 메모 여부, 상단고정 여부 등을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
memo_no Required	메모 번호
content 최대글자수 : [1000자]	메모 내용
use_customer_inquiry	고객상담 동시등록 여부 T : 사용함 F : 사용안함 DEFAULT F
topic_type	상담분류 cs_01 : 배송문의 cs_02 : 상품문의 cs_03 : 결제문의 cs_04 : 주문취소 cs_05 : 상품변경
status	상담결과 F : 처리중 T : 처리완료
attach_type	등록기준 O : 주문별 P : 품목별 DEFAULT O
starred_memo	중요 메모 여부 T : 중요 메모 F : 일반 메모 DEFAULT F
fixed	상단고정 여부 T : 사용함 F : 사용안함 DEFAULT F
product_list	상품 목록

Request Copy

Response Copy

Delete an order memo

DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

DELETE

특정 주문에 대한 메모를 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

memo_no
Required

메모 번호

Request Copy

Response Copy

Orders paymentamount

주문의 실결제금액(Orders paymentamount)은 특정 주문의 실제 결제금액에 대한 기능입니다.
1개 혹은 여러 개의 품주에 대한 실제 결제금액과 관련된 정보를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/paymentamount

Orders paymentamount properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_item_code	품주코드
items	품목 정보
order_price_amount	상품구매금액
order_discount_amount	주문 할인금액
item_discount_amount	상품 할인금액
additional_payment_amount	보조 결제금액
payment_amount	품목별 결제금액

Retrieve a payment amount

GET /api/v2/admin/orders/paymentamount

GET

특정 주문에 포함된 1개 혹은 여러 개의 품주에 대한 실제 결제금액과 관련된 정보를 목록으로 조회할 수 있습니다.
상품구매금액, 상품할인금액 등의 값을 조회할 수 있습니다.
**할인금액 자동계산을 사용하지 않는 품주는 조회할 수 없습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_item_code
Required

품주코드

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Orders payments

주문의 결제상태(Orders payments)는 특정 주문의 결제상태에 대한 기능입니다.

Endpoints

PUT /api/v2/admin/orders/{order_id}/payments

Orders payments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
change_payment_amount	결제금액 변경 여부 T : 사용함 F : 사용안함
change_payment_method	결제수단 변경 여부 T : 사용함 F : 사용안함
payment_method	결제수단
payment_gateway_failure_message	PG 결제 취소 실패 메시지
admin_additional_amount	관리자 입력 금액
commission	결제 수수료
initial_estimated_payment_amount	최초 결제 예정 금액
change_payment_amount_reason	결제금액 변경 사유

Update an order payment status

PUT /api/v2/admin/orders/{order_id}/payments

PUT

특정 주문의 결제상태를 수정할 수 있습니다.
결제취소 상태로 변경하고자 할 경우, 앱을 통해 등록된 PG사에서 결제를 취소할 경우에만 사용이 가능합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
change_payment_amount Required	결제금액 변경 여부 입금전 상태에서만 결제금액 변경 가능 단, CS주문상태 또는 CS처리이력이 존재하는 경우에는 결제금액 변경 불가능함 ※ 결제수단별 입금전 주문상태 - 무통장입금 : 입금전 - 다이비키 : 상품준비중 ~ 배송완료 [다이비키 입금전] T : 사용함 F : 사용안함
change_payment_method Required	결제수단 변경 여부 T : 사용함 F : 사용안함
payment_method	결제수단 cash: 무통장 입금 daibiki : 다이비키
billing_name 최대글자수 : [40자]	입금자명 결제수단을 무통장입금으로 변경할 경우("change_payment_method:"T"이고 "payment_method":"cash"일 경우) 사용 가능
bank_account_id	무통장 입금 은행 ID 결제수단을 무통장입금으로 변경할 경우("change_payment_method:"T"이고 "payment_method":"cash"일 경우) 사용 가능
admin_additional_amount 최소값: [0] 최대값: [10000000]	관리자 입력 금액 결제금액을 변경할 경우("change_payment_amount":"T"일 경우) 사용 가능
commission 최소값: [0] 최대값: [10000000]	결제 수수료 결제수단을 다이비키로 변경할 경우("change_payment_amount:"T"이고 "payment_method":"daibiki"일 경우) 사용 가능
change_payment_amount_reason 최대글자수 : [255자]	결제금액 변경 사유 결제금액을 변경할 경우("change_payment_amount":"T"일 경우) 사용 가능

Request Copy

Response Copy

Orders paymenttimeline

주문의 결제타임라인(Orders paymenttimeline)은 특정 주문의 결제에 대한 시간적인 연대표에 대한 기능입니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/paymenttimeline
GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

Orders paymenttimeline properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
payment_no	결제번호
payment_settle_type	결제유형 O : 최초결제 R : 추가결제 P : 환불
order_amount	주문금액
additional_payment_amount	보조 결제금액
paid_amount	결제금액
payment_methods	결제수단
payment_datetime	결제일
created_datetime	입력일
claim_code	취소/교환/반품 번호
payment_method_detail	결제수단별 결제금액 payment_method_detail code
order_amount_detail	주문금액 상세 order_amount_detail code

Retrieve payment history of an order

GET /api/v2/admin/orders/{order_id}/paymenttimeline

GET

특정 주문의 전체 결제타임라인을 조회할 수 있습니다.
결제유형, 주문금액, 결제일 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
start_date 날짜	검색 시작일
end_date 날짜	검색 종료일
date_type	검색날짜 유형 시작일과 종료일 기준으로 기간 검색시 date_type 미입력시 created_datetime 기준으로 검색 진행 created_datetime : 입력일 payment_datetime : 결제일

Request Copy

Response Copy

Retrieve payment details of an order

GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

GET

특정 주문의 결제번호 1건에 대한 결제타임라인을 조회할 수 있습니다.
결제유형, 주문금액, 결제금액 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

payment_no
Required

최소값: [1]

결제번호

Request Copy

Response Copy

Orders receivers

주문수령자 정보(Orders receivers)는 주문한 상품을 배송 받을 수령자의 이름, 연락처, 주소 등의 정보에 대한 기능 입니다.
수령자 정보는 하위 리소스로서 주문(Order) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

Orders receivers properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
name	수령자명
name_furigana	수령자명 (발음)
phone	전화번호
cellphone	수령자 휴대 전화
virtual_phone_no	수령자 안심번호
zipcode	우편번호
address1	기본 주소
address2	상세 주소
address_state	주/도
address_city	시/군/도시
address_street	도로명
address_full	전체주소
name_en	수령자명 (영문)
city_en	수령자 도시 (영문)
state_en	수령자 주 (영문)
street_en	수령자 주소 (영문)
country_code	국가코드
country_name	국가명
country_name_en	국가명 (영문)
shipping_message	배송 메세지
clearance_information_type	통관정보 유형 I : 신분증 ID P : 여권번호 C : 개인통관고유부호
clearance_information	통관정보
wished_delivery_date	희망배송일
wished_delivery_time	희망배송시간
shipping_code	배송번호
change_default_shipping_address	기본배송지 변경 여부 T : 변경함 F : 변경안함
use_fast_delivery_date	가능한 빠른 배송일 설정 여부 T: 사용함 F: 사용안함
use_fast_delivery_time	가능한 빠른 배송시간 설정 여부 T: 사용함 F: 사용안함

Retrieve a list of recipients of an order

GET /api/v2/admin/orders/{order_id}/receivers

GET

특정 주문의 수령자정보를 목록으로 조회할 수 있습니다.
수령자명, 휴대전화 번호, 주소 등을 조회할 수 있습니다.
부분배송이나 분할배송 등의 경우 하나의 주문에 수령자는 여럿일 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

order_id
Required

주문번호

주문번호

shipping_code

배송번호

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Update order recipients

PUT /api/v2/admin/orders/{order_id}/receivers

PUT

특정 주문의 수령자정보를 수정할 수 있습니다.
복수 배송지 주문일 경우에는 수령자 안심번호는 수정하실 수 없습니다.
수령자명, 수령자 휴대 전화 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
name 최대글자수 : [20자]	수령자명
phone 최대글자수 : [20자]	수령자 일반 전화 한국몰일 경우 02-0000-0000 형태로 입력 그외 해외몰일 경우 국가번호-000-0000 형태로 입력
cellphone 최대글자수 : [20자]	수령자 휴대 전화 한국몰일 경우 010-0000-0000 형태로 입력 그외 해외몰일 경우 국가번호-000-0000 형태로 입력
shipping_message	배송 메세지
name_furigana	수령자명 (발음) 해외몰 중 일본몰인 경우에만 필수 입력
zipcode 최소글자수 : [2자] 최대글자수 : [14자]	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
address_state	주/도 해외몰인 경우 필수 입력
address_city	시/군/도시 해외몰인 경우 필수 입력
name_en	수령자명 (영문)
city_en	수령자 도시 (영문)
state_en	수령자 주 (영문)
street_en	수령자 주소 (영문)
country_code	국가코드 해외몰인 경우 필수 입력 한국 : KR / 중국: CN / 일본: JP / 필리핀: PH / 미국: US / 대만: TW / 베트남 : VN
clearance_information_type	통관정보 유형 I : 신분증 ID P : 여권번호 C : 개인통관고유부호
clearance_information	통관정보
shipping_code	배송번호
change_default_shipping_address	기본배송지 변경 여부 T : 변경함 F : 변경안함 DEFAULT F
virtual_phone_no	수령자 안심번호 복수 배송지 주문일 경우 수령자 안심번호 수정 불가
wished_delivery_date 날짜	희망배송일
use_fast_delivery_date	가능한 빠른 배송일 설정 여부 가능한 빠른 배송시간 설정 여부'가 'T' 일때는 null 로 응답함 T: 사용함 F: 사용안함
wished_delivery_time	희망배송시간 희망배송 시작시간(start_hour) 00~23 까지 입력 가능 희망배송 종료시간(end_hour) 00~23 까지 입력 가능
start_hour 희망배송 시작시간 end_hour 희망배송 종료시간
use_fast_delivery_time	가능한 빠른 배송시간 설정 여부 가능한 빠른 배송일 설정 여부'가 'T' 일때는 null 로 응답함 T: 사용함 F: 사용안함

Request Copy

Response Copy

Change shipping information

PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

PUT

특정 주문의 특정 배송번호에 대한 수령자정보를 수정할 수 있습니다.
배송번호와 관계없이 수령자정보를 수정하기 위해서는 Update orders receivers 를 이용해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required 주문번호	주문번호
shipping_code Required	배송번호
name 최대글자수 : [20자]	수령자명
phone 최대글자수 : [20자]	수령자 일반 전화
cellphone 최대글자수 : [20자]	수령자 휴대 전화
shipping_message	배송 메세지
name_furigana	수령자명 (발음)
zipcode 최소글자수 : [2자] 최대글자수 : [14자]	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
address_state	주/도
address_city	시/군/도시
name_en	수령자명 (영문)
city_en	수령자 도시 (영문)
state_en	수령자 주 (영문)
street_en	수령자 주소 (영문)
country_code	국가코드
clearance_information_type	통관정보 유형 I : 신분증 ID P : 여권번호 C : 개인통관고유부호
clearance_information	통관정보
change_default_shipping_address	기본배송지 변경 여부 T : 변경함 F : 변경안함 DEFAULT F
virtual_phone_no	수령자 안심번호 복수 배송지 주문일 경우 수령자 안심번호 수정 불가
wished_delivery_date 날짜	희망배송일
use_fast_delivery_date	가능한 빠른 배송일 설정 여부 가능한 빠른 배송시간 설정 여부'가 'T' 일때는 null 로 응답함 T: 사용함 F: 사용안함
wished_delivery_time	희망배송시간 희망배송 시작시간(start_hour) 00~23 까지 입력 가능 희망배송 종료시간(end_hour) 00~23 까지 입력 가능
start_hour 희망배송 시작시간 end_hour 희망배송 종료시간
use_fast_delivery_time	가능한 빠른 배송시간 설정 여부 가능한 빠른 배송일 설정 여부'가 'T' 일때는 null 로 응답함 T: 사용함 F: 사용안함
receiver_direct_input_check	주소 직접입력

Request Copy

Response Copy

Orders receivers history

주문수령자 이력(Orders receivers history)은 특정 주문의 수령자 정보 변경이력에 대한 기능입니다.
수정일(updated_date) 파라메터를 통해 언제 정보가 변경되었는지 확인할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/receivers/history

Orders receivers history properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
name	수령자명
phone	전화번호
cellphone	수령자 휴대 전화
zipcode	우편번호
address1	기본 주소
address2	상세 주소
address_state	주/도
address_city	시/군/도시
address_street	도로명
address_full	전체주소
name_en	수령자명 (영문)
city_en	수령자 도시 (영문)
state_en	수령자 주 (영문)
street_en	수령자 주소 (영문)
country_code	국가코드
country_name	국가명
country_name_en	국가명 (영문)
shipping_message	배송 메세지
updated_date	수정일
user_id	주문자 수정자 ID
user_name	주문자 수정자 명
shipping_code	배송번호

Retrieve a list of recipient history of an order

GET /api/v2/admin/orders/{order_id}/receivers/history

GET

주문수령자가 변경된 이력과 그 내용을 조회할 수 있습니다.
수령자명, 전화번호, 주소 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Request Copy

Response Copy

Orders refunds

주문 환불(Orders refunds)은 특정 주문의 환불상태와 관련된 기능입니다.
특정 주문의 환불상태를 수정할 수 있습니다.

Endpoints

PUT /api/v2/admin/orders/{order_id}/refunds/{refund_code}

Orders refunds properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
refund_code	환불번호
status	환불상태
reason	처리사유

Update an order refund

PUT /api/v2/admin/orders/{order_id}/refunds/{refund_code}

PUT

특정 주문의 환불상태를 수정할 수 있습니다.
처리사유를 입력할 수 있고 환불처리 후 SMS 나 메일도 발송되게끔 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
refund_code Required	환불번호
status Required	환불상태 complete : 환불완료
reason 최대글자수 : [2000자]	처리사유
send_sms	환불처리후 SMS 발송 여부 T : 발송함 F : 발송안함 DEFAULT T
send_mail	환불처리후 메일 발송 여부 T : 발송함 F : 발송안함 DEFAULT T
payment_gateway_cancel	PG 취소 요청 여부 T : 취소함 F : 취소안함 DEFAULT F

Request Copy

Response Copy

Orders return

주문 반품(Orders return)은 특정 주문의 반품과 관련된 기능입니다.
특정 주문을 반품처리 하거나, 반품처리중인 주문의 상태를 수정할 수 있습니다.

Endpoints

POST /api/v2/admin/orders/{order_id}/return
PUT /api/v2/admin/orders/{order_id}/return/{claim_code}

Orders return properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
status	주문상태 accepted : 반품접수 processing : 반품처리중 returned : 반품완료
claim_code	반품번호
items	품주코드
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전
carrier_id	배송사 아이디
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name 최대글자수 : [30자]	반품 배송업체명
return_invoice_success	반송장 처리 성공 여부 T : 성공 F : 실패 N : 미집하
return_invoice_fail_reason 최대글자수 : [100자]	반송장 처리 실패 사유
recover_inventory	재고복구 T : 복구함 F : 복구안함
request_pickup	수거신청 여부 T : 사용함 F : 사용안함
pickup	수거지역 상세
undone	철회 여부 T : 철회함 F : 철회안함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason	주문상세내역 노출 철회 사유

Create an order return

POST /api/v2/admin/orders/{order_id}/return

POST

특정 배송 후 주문 하나를 반품 처리할 수 있는 기능입니다.
해당 API를 사용하여 반품완료처리할 경우 환불완료 처리와 함께 PG 취소도 같이 진행할 수 있습니다.(payment_gateway_cancel : "T"로 요청시)
부분반품할 경우 각 환불 금액은 자동 계산되어 환불처리됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
payment_gateway_cancel	PG 취소 요청 여부 주문을 반품처리함과 동시에 PG취소도 같이 처리할 수 있다. PG취소가 가능한 결제수단(신용카드, 실시간계좌이체)에서만 사용 가능하다. 결제수단이 복수인 주문(카드 등으로 결제한 주문을 결제 후 품목을 추가한 경우)의 경우에는 PG 결제를 취소할 수 없으며 관리자 화면에서 취소해야 한다. 오픈마켓/네이버페이 주문을 취소할 경우 사용 불가 T : 취소함 F : 취소안함 DEFAULT F
status Required	주문상태 accepted : 반품접수 processing : 반품처리중 returned : 반품완료
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전 DEFAULT F
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon_no	복원할 쿠폰 번호
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	반품사유
claim_reason_type	반품사유 구분 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_return_reason_type	네이버페이 반품사유 구분 카카오페이 주문을 반품할 경우 사용 불가 EC 베트남, 필리핀, 일본 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 57 : 배송 누락 58 : 미배송 59 : 상품 파손 60 : 상품 정보 상이 61 : 오배송 62 : 색상 등 옵션이 다른 상품 잘못 배송
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 J : 제휴상품권 K : 제휴포인트 I : 기타
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code ※ 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수
refund_bank_name 최대글자수 : [250자]	환불은행명 환불 방식(refund_method)이 현금(T)일 경우 필수 ※ 해당 쇼핑몰이 EC Global 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능
refund_bank_account_no	환불 계좌번호 환불 방식(refund_method)이 현금(T)일 경우 필수
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code Required 품주코드 quantity Required 수량
request_pickup	수거신청 여부 T : 사용함 F : 사용안함
pickup	수거지역 상세
name 이름 phone 전화번호 cellphone 휴대전화 zipcode 우편번호 address1 기본 주소 address2 상세 주소
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name 최대글자수 : [30자]	반품 배송업체명

Request Copy

Response Copy

Update an order return

PUT /api/v2/admin/orders/{order_id}/return/{claim_code}

PUT

주문의 특정 반품번호의 반품접수상태를 수정하는 기능입니다.
반품이 접수된 주문을 수정할 수 있습니다.
Update an orders return 을 통해 반품접수를 철회하거나, 재고를 복구하거나, 철회사유를 입력할 수 있습니다.
택배사에 이미 수거요청이 전달되었으나 수거가 필요하지 않게 될 경우, 택배사에 직접 연락하셔서 수거요청을 취소해주셔야 합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
claim_code Required	반품번호
status	주문상태 processing : 반품처리중 returned : 반품완료
carrier_id	배송사 아이디 배송사에서 반송장번호 업데이트시 carrier_id 필수
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name 최대글자수 : [30자]	반품 배송업체명
return_invoice_success	반송장 처리 성공 여부 T : 성공 F : 실패 N : 미집하
return_invoice_fail_reason 최대글자수 : [100자]	반송장 처리 실패 사유
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 J : 제휴상품권 K : 제휴포인트 I : 기타
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전
items	품주코드
order_item_code 품주코드
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함
recover_coupon_no	복원할 쿠폰 번호
recover_inventory	재고복구 T : 복구함 F : 복구안함
request_pickup	수거신청 여부 반송지 저장시 기본값은 "수거신청함(T)" T : 사용함 F : 사용안함
pickup	수거지역 상세
name 이름 phone 전화번호 cellphone 휴대전화 zipcode 우편번호 address1 기본 주소 address2 상세 주소
undone	철회 여부 T : 철회함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason 최대글자수 : [2000자]	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason 최대글자수 : [2000자]	주문상세내역 노출 철회 사유
refund_bank_code	환불 은행 코드
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no	환불 계좌번호

Request Copy

Response Copy

Orders saleschannels

주문 판매채널(Orders saleschannels)은 통해 주문의 판매처의 조회, 등록, 수정, 삭제를 할 수 있습니다.
주문 판매채널은 하위 리소스로 주문(Orders) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/saleschannels
POST /api/v2/admin/orders/saleschannels
PUT /api/v2/admin/orders/saleschannels/{sales_channel_id}
DELETE /api/v2/admin/orders/saleschannels/{sales_channel_id}

Orders saleschannels properties

Attribute	Description
sales_channel_id	판매처 아이디
sales_channel_name	판매처 이름
sales_channel_icon	판매처 아이콘

Retrieve a list of sales channels

GET /api/v2/admin/orders/saleschannels

GET

쇼핑몰에 등록된 판매채널을 목록으로 조회할 수 있습니다.
판매처의 아이디, 이름, 아이콘 등을 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

limit

최소: [1]~최대: [500]

조회결과 최대건수

DEFAULT 10

offset

최대값: [10000]

조회결과 시작위치

DEFAULT 0

Request Copy

Response Copy

Create a sales channel

POST /api/v2/admin/orders/saleschannels

POST

쇼핑몰에 판매채널을 등록할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
sales_channel_id Required 최대글자수 : [40자] 형식 : [a-zA-Z0-9]	판매처 아이디
sales_channel_name Required 최대글자수 : [100자]	판매처 이름
sales_channel_icon Required URL 최대글자수 : [500자]	판매처 아이콘

Request Copy

Response Copy

Update a sales channel

PUT /api/v2/admin/orders/saleschannels/{sales_channel_id}

PUT

쇼핑몰에 등록된 판매채널을 수정할 수 있습니다.
판매처의 이름, 아이콘 등을 수정할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
sales_channel_id Required 최대글자수 : [40자] 형식 : [a-zA-Z0-9]	판매처 아이디
sales_channel_name 최대글자수 : [100자]	판매처 이름
sales_channel_icon URL 최대글자수 : [500자]	판매처 아이콘

Request Copy

Response Copy

Delete a sales channel

DELETE /api/v2/admin/orders/saleschannels/{sales_channel_id}

DELETE

쇼핑몰에 판매채널을 삭제할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter	Description
sales_channel_id Required 최대글자수 : [40자] 형식 : [a-zA-Z0-9]	판매처 아이디

Request Copy

Response Copy

Orders shipments

주문의 배송(Shipments)은 주문을 배송처리하기 위해 필요한 배송 정보를 의미합니다.
주문의 배송 정보에는 송장번호와 배송사 정보, 배송 상태 등이 있습니다.
주문의 배송 기능을 활용하여 주문을 배송대기 처리하거나 배송중 처리할 수 있으며 송장번호 등도 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/shipments
POST /api/v2/admin/orders/{order_id}/shipments
PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}
DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

Orders shipments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shipping_code	배송번호
order_id	주문번호
tracking_no	송장번호
tracking_no_updated_date	송장번호입력일
shipping_company_code	배송업체 코드 shipping_company_code
items	품주 목록
status	주문상태 standby : 배송대기 shipping : 배송중 shipped : 배송완료
order_item_code	품주코드
carrier_id	배송사 아이디
status_additional_info	주문상태 추가정보

Retrieve a list of shipping information of an order

GET /api/v2/admin/orders/{order_id}/shipments

GET

주문에 등록된 배송번호를 목록으로 조회할 수 있습니다.
배송번호, 주문번호, 송장번호 등을 조회할 수 있습니다.
부분배송으로 진행한 경우 주문1건에 배송번호는 여러개일 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

주문번호

Request Copy

Response Copy

Create an order shipping information

POST /api/v2/admin/orders/{order_id}/shipments

POST

주문에 송장번호 등의 배송정보를 등록하여 주문을 배송대기 시키거나 배송중 처리할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
tracking_no Required 최대글자수 : [40자]	송장번호
shipping_company_code Required	배송업체 코드 shipping_company_code
order_item_code	품주코드
status Required	주문상태 standby : 배송대기 shipping : 배송중
shipping_code	배송번호
carrier_id	배송사 아이디

Request Copy

Response Copy

Update an order shipping

PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

PUT

주문에 등록된 배송번호의 배송 정보를 수정할 수 있습니다.
주문상태, 배송업체 코드 등을 변경할 수 있습니다.
부분배송으로 진행한 경우 주문1건에 배송번호는 여러개일 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
shipping_code Required	배송번호
status	주문상태 status 사용하여 배송상태 수정시 tracking_no, shipping_company_code는 사용 불가 standby : 배송대기 shipping : 배송중 shipped : 배송완료
status_additional_info 최대글자수 : [30자]	주문상태 추가정보
tracking_no 최대글자수 : [40자]	송장번호 tracking_no 사용시 shipping_company_code를 함께 사용해야 하며, 송장번호 수정시 status는 사용 불가
shipping_company_code	배송업체 코드 shipping_company_code tracking_no 사용시 shipping_company_code를 함께 사용해야 하며, 송장번호 수정시 status는 사용 불가

Request Copy

Response Copy

Delete an order shipping

DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

DELETE

주문에 등록된 배송번호를 삭제할 수 있습니다.
부분배송으로 진행한 경우 주문1건에 배송번호는 여러개일 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

shipping_code
Required

배송번호

Request Copy

Response Copy

Orders shippingfeecancellation

주문의 배송비취소(Orders shippingfeecancellation)를 통해 주문의 취소현황을 조회하거나 취소처리를 요청할 수 있습니다.

Endpoints

GET /api/v2/admin/orders/{order_id}/shippingfeecancellation
POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

Orders shippingfeecancellation properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
default_shipping_fee	기본 배송비
supplier_shipping_fee	공급사배송비
individual_shipping_fee	개별배송비
international_shipping_fee	해외배송비
international_shipping_insurance_fee	해외배송 보험료
additional_shipping_fee	추가 배송비
additional_handling_fee	해외배송 부가금액
regional_surcharge_amount	지역별 배송비
claim_code	취소 번호
claim_reason_type	구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	사유
refund_method	환불 방식
shipping_discount_amount	배송비할인 취소액
coupon_discount_amount	쿠폰할인 취소액
refund_amount	환불금액
point_used	사용된 적립금 반환액
credit_used	사용된 예치금 반환액
mixed_refund_amount	복합 환불 금액
mixed_refund_methods	복합 환불 방식
status	주문상태 canceled: 취소완료 canceling : 취소처리중
include_tax	가격에 세금 포함 T: 세금포함 F: 세금제외
tax	세금 정보 세금 관리자 앱을 사용 안 할 경우 null로 반환

Retrieve shipping fee cancellation details of an order

GET /api/v2/admin/orders/{order_id}/shippingfeecancellation

GET

주문의 취소처리 현황을 목록으로 조회할 수 있습니다.
기본 배송비, 공급사 배송비, 지역별 배송비 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

order_id
Required

주문번호

Request Copy

Response Copy

Create an order shipping fee cancellation

POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

POST

주문의 취소처리를 요청할 수 있습니다.
본 API는 취소를 요청하는 것이고 취소를 처리하는 것은 아닌 점 참고 부탁 드립니다.
PG 취소까지 자동으로 되는 것은 아니며 payment_gateway_cancel 파라메터를 T 로 하여 함께 요청해야만 PG도 동시에 취소요청 됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
reason 최대글자수 : [2000자]	취소사유
claim_reason_type	취소사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함 DEFAULT F
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 J : 제휴상품권 K : 제휴포인트 I : 기타
refund_bank_code	환불 은행 코드
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no	환불 계좌번호
refund_bank_account_holder 최대글자수 : [30자]	환불계좌 예금주 명의
payment_gateway_cancel	PG 취소 요청 여부 T : 취소함 F : 취소안함 DEFAULT F

Request Copy

Response Copy

Orders shortagecancellation

주문의 재고부족취소(Orders shortagecancellation)는 이벤트 혹은 재고설정의 착오 등으로 인해 보유한 재고보다 많은 수량이 판매되었을 때
취소완료 및 환불까지 처리할 수 있는 기능입니다.

Endpoints

POST /api/v2/admin/orders/{order_id}/shortagecancellation

Orders shortagecancellation properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
order_id	주문번호
status	주문상태 canceled : 취소완료 canceling : 취소처리중
claim_code	취소 번호
items	품주코드

Create an order cancellation on stock shortage

POST /api/v2/admin/orders/{order_id}/shortagecancellation

POST

특정 주문을 취소처리 및 환불까지 처리할 수 있습니다.
재고나 쿠폰의 복원 여부도 선택할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
order_id Required	주문번호
payment_gateway_cancel	PG 취소 요청 여부 T : 취소함 F : 취소안함 DEFAULT F
keep_auto_calculation	할인금액 자동계산 플래그 보존여부 보존함 : T 제거함 : F DEFAULT F
collect_gift	사은품 자동 회수 T : 사용함 F : 사용안함 DEFAULT F
status Required	주문상태 canceled : 취소완료 canceling : 취소처리중
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon_no	복원할 쿠폰 번호
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	취소사유
claim_reason_type	취소사유 구분 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_cancel_reason_type	네이버페이 취소사유 구분 EC 베트남, 필리핀 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 60 : 상품 정보 상이
kakaopay_cancel_reason_type	카카오페이 취소사유 구분 K1 : 변심에 의한 상품 취소 K2 : 다른 옵션이나 상품을 잘못 주문함 K3 : 배송지연 K4 : 상품 파손 또는 불량 K5 : 다른 상품 오배송 또는 구성품 누락 K6 : 상품정보와 다름 K7 : 품절로 인한 배송 불가
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 J : 제휴상품권 K : 제휴포인트 I : 기타
refund_bank_code	환불 은행 코드
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no	환불 계좌번호
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code Required 품주코드 quantity Required 수량

Request Copy

Response Copy

Payments

결제상태(Payments)는 특정 주문의 결제상태에 대한 기능입니다.

Endpoints

PUT /api/v2/admin/payments

Payments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
status	주문상태 paid: 입금확인 unpaid: 입금전 canceled: 결제취소
auto_paid	자동입금 여부 T: 자동입금 F: 수동입금
cancel_request	결제취소 요청 정보

Update payment status for multiple orders

PUT /api/v2/admin/payments

PUT

특정 주문의 결제상태를 수정할 수 있습니다.
결제취소 상태로 변경하고자 할 경우, 앱을 통해 등록된 PG사에서 결제를 취소할 경우에만 사용이 가능합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
status Required	결제상태 canceled의 경우 앱을 통해 추가된 PG사에서 결제를 취소할 경우에만 사용 가능 paid: 입금확인 unpaid: 입금전 canceled: 결제취소
auto_paid	자동입금 여부 T: 자동입금 F: 수동입금
recover_inventory	재고복구 T : 복구함 F : 복구안함
cancel_request	결제취소 요청 정보
refund_status 환불 처리 상태 P: 환불완료 F: 환불실패 DEFAULT F partial_cancel 부분 취소 여부 T: 부분취소 F: 전체취소 DEFAULT F payment_gateway_name 결제 PG사 이름 payment_method 결제수단 코드 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 cell : 휴대폰 deferpay : 후불 cvs : 편의점 easypay : 간편결제 fpayment : 해외결제 response_code 결제 PG 사의 응답 코드 response_message 결제 PG 사의 응답 메시지

Request Copy

Response Copy

Refunds

환불(Refunds)은 주문의 상태가 환불과 관련된 상태에 대해 조회할 수 있는 기능입니다.
환불전, 환불보류, 환불완료 단계가 아닌 주문에 대해서는 조회할 수 없으므로 주문상태를 잘 확인하고 사용해주세요.

Endpoints

GET /api/v2/admin/refunds
GET /api/v2/admin/refunds/{refund_code}

Refunds properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
member_id	회원아이디
member_email	회원 이메일
buyer_email	주문자 이메일
order_date	주문일
accepted_refund_date	환불접수일자
refund_date	환불완료일자
order_id	주문번호
refund_code	환불번호
order_item_code	품주코드 목록
quantity	수량
actual_refund_amount	실환불금액
used_points	사용된 적립금 반환액
used_credits	사용된 예치금 반환액
currency	화폐단위
payment_methods	결제수단 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 icash : 가상계좌 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 coupon : 쿠폰 market_discount : 마켓할인 giftcard : 제휴상품권 pointcard : 제휴포인트 etc : 기타
refund_payment_methods	환불 결제수단 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 giftcard : 제휴상품권 pointcard : 제휴포인트 etc : 기타
payment_gateway_cancel_statuses	PG 취소상태 F : 취소전 M : 부분취소 완료 T : 전체취소 완료
payment_gateway_cancel_dates	PG 취소처리 일자
status	환불상태 T : 환불완료 F : 환불전
refund_methods	환불 방식
refund_bank_name	환불은행명
refund_bank_account_no	환불 계좌번호
refund_bank_account_holder	환불계좌 예금주 명의
include_tax	가격에 세금 포함 T: 세금포함 F: 세금제외
tax	세금 정보 세금 관리자 앱을 사용 안 할 경우 null로 반환
refund_point	적립금 반환액
refund_credit	예치금 반환액
refund_naver_point	네이버 포인트 반환액
refund_naver_cash	네이버 캐시 반환액
refund_amount	환불금액
product_price	상품 판매가
shipping_fee	배송비 DEFAULT 0.00
refund_shipping_fee	환불배송비 DEFAULT 0.00
refund_regional_surcharge	지역별 환불배송비 DEFAULT 0.00
return_shipping_fee	반품배송비 DEFAULT 0.00
return_regional_surcharge	지역별 반품배송비 DEFAULT 0.00
additional_shipping_fee	추가 배송비 DEFAULT 0.00
international_shipping_insurance	해외배송 보험료 DEFAULT 0.00
international_shipping_additional_fee	해외배송 부가금액 DEFAULT 0.00
shipping_fee_discount_amount	배송비할인
cod_fees	후불 결제 수수료
product_discount_amount	상품별 할인금액
member_group_discount_amount	회원등급 할인금액
app_item_discount_amount	앱 상품할인금액
app_discount_amount	앱 주문할인금액
coupon_discount_amount	쿠폰 할인금액
product_bundle_discount_amount	세트상품 할인금액
points_spent_amount	적립금사용금액
credits_spent_amount	예치금사용금액
naver_point	네이버포인트
naver_cash	네이버캐시
additional_product_amount	상품 추가 결제금액
manually_input_amount	관리자 입력 금액
changed_refund_amount	변경된 환불금액
refund_manager	환불 담당자
refund_reason	환불사유
send_sms	환불처리후 SMS 발송 여부 T : 발송함 F : 발송안함
send_mail	환불처리후 메일 발송 여부 T : 발송함 F : 발송안함
items	품주 리소스

Retrieve a list of refunds

GET /api/v2/admin/refunds

GET

환불과 관련된 상태인 주문들을 목록으로 조회할 수 있습니다.
회원 이메일, 주문일, 환불접수일자 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
date_type	검색날짜 유형 accepted_refund_date : 환불접수일 refund_date : 환불완료일 DEFAULT refund_date
member_email	회원 이메일
buyer_email	주문자 이메일
order_id 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
member_id 최대글자수 : [20자]	회원아이디
refund_status	CS(환불)상태 ,(콤마)로 여러 건을 검색할 수 있다. F : 환불전 T : 환불완료 M : 환불보류
limit 최소: [1]~최대: [500]	조회결과 최대건수 DEFAULT 10
offset 최대값: [15000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Retrieve a refund

GET /api/v2/admin/refunds/{refund_code}

GET

특정 환불번호에 대한 정보를 조회할 수 있습니다.
환불 사유, 환불 결제 수당 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

refund_code
Required

환불번호

items
embed

품주 리소스

Request Copy

Response Copy

Reservations

Endpoints

GET /api/v2/admin/reservations

Reservations properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id	주문번호
order_item_code	품주코드
order_date	주문일
payment_date	결제일
member_id	회원아이디
order_status	주문상태
shipping_code	배송번호
payment_method	결제수단 코드 cash : 무통장 card : 신용카드 cell : 휴대폰 tcash : 계좌이체 icash : 가상계좌 prepaid : 선불금 credit : 예치금 point : 적립금 pointfy : 통합포인트 cvs : 편의점 cod : 후불 coupon : 쿠폰 market_discount : 마켓할인 giftcard : 제휴상품권 pointcard : 제휴포인트 etc : 기타
payment_method_name	결제수단명
product_no	상품번호
product_name	상품명
product_name_default	기본 상품명
product_price	상품 판매가
option_price	옵션 추가 가격
quantity	수량
option_value	옵션값
option_value_default	기본옵션값
additional_option_values	추가입력 옵션 목록
payment_amount	품목별 결제금액
paid	결제 여부 T : 결제 F : 미결제 M : 부분 결제
service_use_date	서비스 이용일
service_available_start_date	서비스 이용가능기간 시작일
service_available_end_date	서비스 이용가능기간 종료일
service_completion_date	서비스 이용 완료일

Retrieve pre-order item

GET /api/v2/admin/reservations

GET

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
date_type	검색날짜 유형 order_date: 주문일 pay_date: 결제일 service_use_date: 서비스 이용일 DEFAULT order_date
start_date 날짜	검색 시작일
end_date 날짜	검색 종료일
order_id 주문번호	주문번호 ,(콤마)로 여러 건을 검색할 수 있다.
order_item_code	품주코드 ,(콤마)로 여러 건을 검색할 수 있다.
buyer_name	주문자명
member_id	회원아이디
member_email	회원 이메일
buyer_email	주문자 이메일
buyer_cellphone	주문자 휴대 전화
product_no	상품번호 ,(콤마)로 여러 건을 검색할 수 있다.
order_status	주문상태 ,(콤마)로 여러 건을 검색할 수 있다. N00 : 입금전 N10 : 상품준비중 N20 : 배송준비중 N21 : 배송대기 N22 : 배송보류 N30 : 배송중 N40 : 배송완료 N50 : 구매확정 C00 : 취소신청 C10 : 취소접수 - 관리자 C11 : 취소접수거부 - 관리자 C34 : 취소처리중 - 환불전 C35 : 취소처리중 - 환불완료 C36 : 취소처리중 - 환불보류 C40 : 취소완료 C41 : 취소 완료 - 환불전 C42 : 취소 완료 - 환불요청중 C43 : 취소 완료 - 환불보류 C47 : 입금전취소 - 구매자 C48 : 입금전취소 - 자동취소 C49 : 입금전취소 - 관리자 R00 : 반품신청 R10 : 반품접수 R11 : 반품 접수 거부 R12 : 반품보류 R13 : 반품접수 - 수거완료(자동) R20 : 반품 수거 완료 R30 : 반품처리중 - 수거전 R31 : 반품처리중 - 수거완료 R34 : 반품처리중 - 환불전 R36 : 반품처리중 - 환불보류 R40 : 반품완료 - 환불완료 R41 : 반품완료 - 환불전 R42 : 반품완료 - 환불요청중 R43 : 반품완료 - 환불보류 E00 : 교환신청 E10 : 교환접수 N01 : 교환접수 - 교환상품 E11 : 교환접수거부 E12 : 교환보류 E13 : 교환접수 - 수거완료(자동) E20 : 교환준비 E30 : 교환처리중 - 수거전 E31 : 교환처리중 - 수거완료 E32 : 교환처리중 - 입금전 E33 : 교환처리중 - 입금완료 E34 : 교환처리중 - 환불전 E35 : 교환처리중 - 환불완료 E36 : 교환처리중 - 환불보류 E40 : 교환완료 E41 : 교환 완료 - 교환철회 E50 : 교환철회 - 판매자 E51 : 교환철회 - 구매자
payment_status	결제상태 F : 입금전 M : 추가입금대기 P : 결제완료
sort	정렬 순서 값 order_date: 주문일 service_use_date: 서비스 이용일 DEFAULT order_date
order	정렬 순서 asc : 순차정렬 desc : 역순 정렬 DEFAULT desc
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Return

반품(Return)은 쇼핑몰 고객이 배송 후 주문을 취소하는 것을 의미합니다.
반품 리소스는 반품접수 이후부터 반품완료까지의 주문 상태를 조회할 수 있습니다.
반품 리소스에서는 반품 정보를 조회하거나 반품을 처리할 수 있습니다.

Endpoints

GET /api/v2/admin/return/{claim_code}
POST /api/v2/admin/return
PUT /api/v2/admin/return

Return properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
claim_code	반품번호
claim_reason_type	구분 판매자의 반품 접수 사유 구분. 구매자의 반품 신청 사유는 items(품목 주문) > claim_reason_type으로 조회할 수 있다. A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
claim_reason	사유 판매자의 반품 접수 사유 상세 내용. 구매자의 반품 신청 사유 상세 내용은 items(품목 주문) > claim_reason으로 조회할 수 있다.
claim_due_date	반품처리 예정일
return_address	반품주소
pickup	수거지역 상세
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name 최대글자수 : [30자]	반품 배송업체명
pickup_request_state	수거 신청 상태 E : 수거 미신청 W : 수거 미접수 S : 수거접수대기(송장발급전) F : 수거접수실패 T : 수거접수완료(송장발급완료) N : 미집하
refund_methods	환불 방식
refund_reason	비고
order_price_amount	상품구매금액
refund_amounts	환불금액
shipping_fee	배송비 DEFAULT 0.00
refund_shipping_fee	환불배송비 DEFAULT 0.00
refund_regional_surcharge	지역별 환불배송비 DEFAULT 0.00
return_ship_type	반품배송비 적용구분
return_shipping_fee	반품배송비 DEFAULT 0.00
return_shipping_fee_detail	반품배송비 상세
return_regional_surcharge	지역별 반품배송비 DEFAULT 0.00
return_regional_surcharge_detail	지역별 반품배송비 상세
additional_shipping_fee	추가 배송비 DEFAULT 0.00
international_shipping_insurance	해외배송 보험료 DEFAULT 0.00
international_shipping_additional_fee	해외배송 부가금액 DEFAULT 0.00
defer_commission	후불 결제 수수료
partner_discount_amount	제휴할인 취소액
add_discount_amount	상품별추가할인 취소액
member_grade_discount_amount	회원등급할인 취소액
shipping_discount_amount	배송비할인 취소액
coupon_discount_amount	쿠폰할인 취소액
point_used	사용된 적립금 반환액
credit_used	사용된 예치금 반환액
undone	철회 여부 T : 철회함 F : 철회안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason	주문상세내역 노출 철회 사유
items	품주코드
include_tax	가격에 세금 포함 T: 세금포함 F: 세금제외
tax	세금 정보 세금 관리자 앱을 사용 안 할 경우 null로 반환
carrier_id	배송사 아이디
return_invoice_success	반송장 처리 성공 여부 T : 성공 F : 실패 N : 미집하
return_invoice_fail_reason	반송장 처리 실패 사유
status	주문상태 accepted : 반품접수 processing : 반품처리중 returned : 반품완료
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전
recover_inventory	재고복구 T : 복구함 F : 복구안함
request_pickup	수거신청 여부 T : 사용함 F : 사용안함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함

Retrieve a return

GET /api/v2/admin/return/{claim_code}

GET

주문의 반품 정보를 조회할 수 있습니다.
반품번호는 필수 입력값입니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

claim_code
Required

반품번호

Request Copy

Response Copy

Create multiple order returns

POST /api/v2/admin/return

POST

여러 배송 후 주문을 반품 처리할 수 있는 기능입니다.
해당 API를 사용하여 반품 처리할 경우 환불완료까지 처리 되지만 PG 취소까지는 진행되지 않으므로, 솔루션에서 별도 PG 취소처리를 해주어야 합니다.
부분반품할 경우 각 환불 금액은 자동 계산되어 환불처리됩니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
status Required	주문상태 accepted : 반품접수 processing : 반품처리중 returned : 반품완료
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전 DEFAULT F
recover_inventory	재고복구 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함 DEFAULT F
recover_coupon_no	복원할 쿠폰 번호
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함 DEFAULT F
reason 최대글자수 : [2000자]	반품사유
claim_reason_type	반품사유 구분 A : 고객변심 B : 배송지연 C : 배송불가지역 L : 수출/통관 불가 D : 포장불량 E : 상품불만족 F : 상품정보상이 G : 서비스불만족 H : 품절 I : 기타
naverpay_return_reason_type	네이버페이 반품사유 구분 카카오페이 주문을 반품할 경우 사용 불가 EC 베트남, 필리핀, 일본 버전에서는 사용할 수 없음. 51 : 구매 의사 취소 52 : 색상 및 사이즈 변경 53 : 다른 상품 잘못 주문 54 : 서비스 및 상품 불만족 55 : 배송 지연 56 : 상품 품절 57 : 배송 누락 58 : 미배송 59 : 상품 파손 60 : 상품 정보 상이 61 : 오배송 62 : 색상 등 옵션이 다른 상품 잘못 배송
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 J : 제휴상품권 K : 제휴포인트 I : 기타
refund_bank_code	환불 은행 코드 환불 방식(refund_method)이 현금(T)일 경우 필수 refund_bank_code ※ 해당 쇼핑몰이 EC Korea 쇼핑몰일 경우 필수
refund_bank_name 최대글자수 : [250자]	환불은행명 환불 방식(refund_method)이 현금(T)일 경우 필수 ※ 해당 쇼핑몰이 EC Global 쇼핑몰일 경우 필수 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능
refund_bank_account_no	환불 계좌번호 환불수단(refund_method)이 "현금(T)"일 때만 사용 가능
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주코드
order_item_code Required 품주코드 quantity Required 수량
request_pickup	수거신청 여부 T : 사용함 F : 사용안함
pickup	수거지역 상세
name 이름 phone 전화번호 cellphone 휴대전화 zipcode 우편번호 address1 기본 주소 address2 상세 주소
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name 최대글자수 : [30자]	반품 배송업체명

Request Copy

Response Copy

Update a return

PUT /api/v2/admin/return

PUT

주문의 반품접수상태를 수정하는 기능입니다.
반품이 접수된 주문을 수정할 수 있습니다.
Update return 을 통해 반품접수를 철회하거나, 재고를 복구하거나, 철회사유를 입력할 수 있습니다.
택배사에 이미 수거요청이 전달되었으나 수거가 필요하지 않게 될 경우, 택배사에 직접 연락하셔서 수거요청을 취소해주셔야 합니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
claim_code Required	반품번호
status	주문상태 processing : 반품처리중 returned : 반품완료
pickup_completed	수거완료 여부 T : 수거완료 F : 수거전
carrier_id	배송사 아이디 배송사에서 반송장번호 업데이트시 carrier_id 필수
refund_method_code	환불 방식 T : 현금 F : 신용카드 M : 적립금 G : 계좌이체 C : 휴대폰 D : 예치금 Z : 후불 O : 선불금 V : 편의점 J : 제휴상품권 K : 제휴포인트 I : 기타
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
return_invoice_no 최대글자수 : [40자]	반품 송장 번호
return_shipping_company_name 최대글자수 : [30자]	반품 배송업체명
return_invoice_success	반송장 처리 성공 여부 T : 성공 F : 실패 N : 미집하
return_invoice_fail_reason 최대글자수 : [100자]	반송장 처리 실패 사유
items	품주코드
order_item_code 품주코드
recover_coupon	쿠폰 복원 T : 복구함 F : 복구안함
recover_coupon_no	복원할 쿠폰 번호
recover_inventory	재고복구 T : 복구함 F : 복구안함
request_pickup	수거신청 여부 반송지 저장시 기본값은 "수거신청함(T)" T : 사용함 F : 사용안함
pickup	수거지역 상세
name 이름 phone 전화번호 cellphone 휴대전화 zipcode 우편번호 address1 기본 주소 address2 상세 주소
undone	철회 여부 T : 철회함
add_memo_too	관리자 메모에도 추가 T : 사용함 F : 사용안함
undone_reason_type	철회 사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
undone_reason 최대글자수 : [2000자]	철회 사유
expose_order_detail	주문상세내역 노출 여부 T : 노출함 F : 노출안함
exposed_undone_reason 최대글자수 : [2000자]	주문상세내역 노출 철회 사유
refund_bank_code	환불 은행 코드
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no	환불 계좌번호

Request Copy

Response Copy

Returnrequests

반품요청(Returnrequests)을 통해 특정 주문의 반품에 대한 요청을 접수하거나 거부할 수 있습니다.

Endpoints

POST /api/v2/admin/returnrequests
PUT /api/v2/admin/returnrequests

Returnrequests properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
order_id	주문번호
items	품주 목록
undone	접수거부 여부
order_item_code	품주코드
additional_payment_gateway_cancel	추가 PG 취소

Create a return request for multiple items

POST /api/v2/admin/returnrequests

POST

반품을 요청할 수 있습니다.
반품사유와 계좌환불인 경우 환불할 계좌번호를 입력할 수 있습니다.
,(콤마)로 여러 건을 동시에 반품요청 할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
reason_type Required	사유 구분 A:고객변심 E:상품불만족 K:상품불량 J:배송오류 I:기타
reason Required 최대글자수 : [2000자]	사유
request_pickup Required	수거신청 여부 T : 수거신청 F : 직접발송
pickup	수거지역 상세
name Required 이름 phone 전화번호 cellphone Required 휴대전화 zipcode Required 우편번호 address1 Required 기본 주소 address2 Required 상세 주소
tracking_no 최대글자수 : [40자]	반품 송장 번호
shipping_company_name 최대글자수 : [30자]	반품 배송업체명
refund_bank_code	환불 은행 코드
refund_bank_name 최대글자수 : [250자]	환불은행명
refund_bank_account_no	환불 계좌번호
refund_bank_account_holder 최대글자수 : [15자]	환불계좌 예금주 명의
items	품주 목록
order_item_code Required 품주코드 quantity Required 수량

Request Copy

Response Copy

Reject a return request for multiple items

PUT /api/v2/admin/returnrequests

PUT

반품이 요청된 주문의 특정 품주들에 대하여 반품요청중인 상태를 변경할 수 있습니다.
접수거부를 할 수 있고 사유를 입력할 수 있습니다.
,(콤마)로 여러 건의 반품 요청을 동시에 접수거부 할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
order_id Required	주문번호
order_item_code Required	품주코드
undone Required	접수거부 여부 T : 접수거부함
reason_type	사유 구분 A:고객변심 B:배송지연 J:배송오류 C:배송불가지역 L:수출/통관 불가 D:포장불량 E:상품 불만족 F:상품정보상이 K:상품불량 G:서비스불만족 H:품절 I:기타
reason 최대글자수 : [2000자]	사유
display_reject_reason	주문상세내역 노출설정 T : 노출함 F : 노출안함 DEFAULT F
reject_reason 최대글자수 : [2000자]	거부 사유

Request Copy

Response Copy

Shipments

배송(Shipments)은 주문의 하위리소스인 주문의 배송(Orders shipments)과 다르게 여러 주문의 배송 정보를 한번에 등록하거나 수정할 수 있습니다.
배송 정보에는 송장번호와 배송사 정보, 배송 상태 등이 있습니다.

Endpoints

POST /api/v2/admin/shipments
PUT /api/v2/admin/shipments

Shipments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
tracking_no	송장번호
shipping_company_code	배송업체 코드 shipping_company_code
status	주문상태 standby : 배송대기 shipping : 배송중 shipped : 배송완료
order_id	주문번호
shipping_code	배송번호
order_item_code	품주코드
carrier_id	배송사 아이디
status_additional_info	주문상태 추가정보

Create shipping information for multiple orders

POST /api/v2/admin/shipments

POST

복수의 주문에 대하여 송장번호를 등록하여 배송대기나 배송중 상태로 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
tracking_no Required 최대글자수 : [40자]	송장번호
shipping_company_code Required	배송업체 코드 shipping_company_code
status Required	주문상태 standby : 배송대기 shipping : 배송중
order_id	주문번호
shipping_code	배송번호
order_item_code	품주코드
carrier_id	배송사 아이디

Request Copy

Response Copy

Update multiple order shippings

PUT /api/v2/admin/shipments

PUT

복수의 배송번호에 대하여 주문상태를 변경하거나 송장번호 등을 수정할 수 있습니다.
배송번호는 Create shipments 를 통해 송장번호를 등록해야만 발급받을 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shipping_code Required	배송번호
order_id	주문번호
status	주문상태 status 사용하여 배송상태 수정시 tracking_no, shipping_company_code는 사용 불가 standby : 배송대기 shipping : 배송중 shipped : 배송완료
status_additional_info 최대글자수 : [30자]	주문상태 추가정보
tracking_no 최대글자수 : [40자]	송장번호 tracking_no 사용시 shipping_company_code를 함께 사용해야 하며, 송장번호 수정시 status는 사용 불가
shipping_company_code	배송업체 코드 해당 주문의 송장번호와 함께 배송사를 변경할 수 있다. shipping_company_code tracking_no 사용시 shipping_company_code를 함께 사용해야 하며, 송장번호 수정시 status는 사용 불가

Request Copy

Response Copy

Subscription shipments

정기배송(Subscription shipments)은 정기배송에 대한 조회, 등록, 수정, 삭제를 할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/subscription/shipments
POST /api/v2/admin/subscription/shipments
PUT /api/v2/admin/subscription/shipments/{subscription_id}

Subscription shipments properties

Attribute	Description
subscription_id	정기배송 신청번호
member_id	회원아이디
buyer_name	주문자 이름
buyer_zipcode	주문자 우편번호
buyer_address1	주문자 기본 주소
buyer_address2	주문자 상세 주소
buyer_phone	주문자 일반 전화
buyer_cellphone	주문자 휴대 전화
buyer_email	주문자 이메일
receiver_name 최대글자수 : [100자]	수령자 명
receiver_zipcode	수령자 우편번호
receiver_address1	수령자 기본 주소
receiver_address2	수령자 상세 주소
receiver_phone	수령자 일반 전화
receiver_cellphone	수령자 휴대 전화
shipping_message	배송 메세지
delivery_type	배송 유형 A : 국내 B : 해외
wished_delivery	희망배송일 사용여부 T : 사용함 F : 사용안함
wished_delivery_start_hour	희망배송시작시간
wished_delivery_end_hour	희망배송종료시간
wished_delivery_hour_asap	가능한 빠른 배송시간 T : 사용함 F : 사용안함
store_pickup	스토어픽업 T : 사용함 F : 사용안함
use_virtual_phone_no	안심번호 T : 사용함 F : 사용안함
created_date	신청일자
subscription_state	정기배송 상태 U:이용중 P: 일시정지 C:해지
items	주문상품목록

Retrieve a subscription

GET /api/v2/admin/subscription/shipments

GET

정기배송을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 읽기권한 (mall.read_order)
호출건수 제한	40

요청사양

Parameter	Description
date_type	검색날짜 유형 created_date : 신청일 expected_pay_date : 결제예정일 terminated_date : 해지일 DEFAULT created_date
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
subscription_id	정기배송 신청번호
member_id 최대글자수 : [20자]	회원아이디
buyer_name 최대글자수 : [100자]	주문자 이름
buyer_phone	주문자 일반 전화
buyer_cellphone	주문자 휴대 전화
product_no	상품번호 ,(콤마)로 여러 건을 검색할 수 있다.
product_name 최대글자수 : [250자]	상품명
product_code	상품코드
variant_code	품목코드
subscription_shipments_cycle	배송주기 ,(콤마)로 여러 건을 검색할 수 있다. 1W : 1주 2W : 2주 3W : 3주 4W : 4주 1M : 1개월 2M : 2개월 3M : 3개월 4M : 4개월 5M : 5개월 6M : 6개월 1Y : 1년
subscription_state	정기배송 상태 U:이용중 P: 일시정지 C:해지
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 20
offset 최대값: [5000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Create a subscription

POST /api/v2/admin/subscription/shipments

POST

정기배송을 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
member_id Required 최대글자수 : [20자]	회원아이디
buyer_name Required 최대글자수 : [100자]	주문자 이름
buyer_zipcode Required 글자수 최소: [2자]~최대: [14자]	주문자 우편번호
buyer_address1 Required 최대글자수 : [250자]	주문자 기본 주소
buyer_address2 Required	주문자 상세 주소
buyer_phone 최대글자수 : [20자]	주문자 일반 전화
buyer_cellphone Required 최대글자수 : [20자]	주문자 휴대 전화
buyer_email Required 이메일	주문자 이메일
receiver_name Required 최대글자수 : [100자]	수령자 명
receiver_zipcode Required 글자수 최소: [2자]~최대: [13자]	수령자 우편번호
receiver_address1 Required	수령자 기본 주소
receiver_address2 Required	수령자 상세 주소
receiver_phone Required 최대글자수 : [20자]	수령자 일반 전화
receiver_cellphone Required 최대글자수 : [20자]	수령자 휴대 전화
shipping_message	배송 메세지
delivery_type	배송 유형 A : 국내 B : 해외 DEFAULT A
expected_delivery_date Required 날짜	배송시작일
subscription_shipments_cycle Required	배송주기 1W : 1주 2W : 2주 3W : 3주 4W : 4주 1M : 1개월 2M : 2개월 3M : 3개월 4M : 4개월 5M : 5개월 6M : 6개월 1Y : 1년
wished_delivery	희망배송일 사용여부 T : 사용함 F : 사용안함 DEFAULT F
wished_delivery_start_hour 최소: [0]~최대: [23]	희망배송시작시간
wished_delivery_end_hour 최소: [0]~최대: [23]	희망배송종료시간
wished_delivery_hour_asap	가능한 빠른 배송시간 T : 사용함 F : 사용안함
store_pickup	스토어픽업 T : 사용함 F : 사용안함 DEFAULT F
use_virtual_phone_no	안심번호 T : 사용함 F : 사용안함 DEFAULT F
items	주문상품목록
product_code Required 상품코드 product_no Required 상품번호 product_name Required 상품명 options Array name 옵션명 value 옵션값 option_code 연동형 옵션코드 value_no 연동형 옵션값 option_id Required 상품옵션 아이디 DEFAULT 000A quantity Required 주문 수량 product_price Required 상품 판매가 option_price 옵션 추가 가격 shipping_payment_option 선/착불 구분 C : 착불 P : 선결제 F : 무료 category_no 분류 번호 product_bundle 세트상품 여부 T : 세트상품 F : 세트상품 아님 DEFAULT F bundle_product_components Array product_code 상품코드 product_no 상품번호 option_id 상품옵션 아이디 quantity 주문 수량

Request Copy

Response Copy

Update a subscription

PUT /api/v2/admin/subscription/shipments/{subscription_id}

PUT

정기배송 정보를 수정할 수 있습니다.
정기배송 신청번호는 필수 입력값입니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
subscription_id Required	정기배송 신청번호
receiver_name 최대글자수 : [100자]	수령자 명
receiver_zipcode 글자수 최소: [2자]~최대: [14자]	수령자 우편번호
receiver_address1	수령자 기본 주소
receiver_address2	수령자 상세 주소
receiver_phone 최대글자수 : [20자]	수령자 일반 전화
receiver_cellphone 최대글자수 : [20자]	수령자 휴대 전화
shipping_message	배송 메세지
subscription_state	정기배송 상태 U:이용중 P:일시정지 C:해지

Request Copy

Response Copy

Subscription shipments items

정기배송 품목(Subscription shipments items)을 통해 정기배송 품목별 수정을 할 수 있습니다.

Endpoints

PUT /api/v2/admin/subscription/shipments/{subscription_id}/items

Subscription shipments items properties

Attribute	Description
variant_code	품목코드
option_id	상품옵션 아이디
subscription_state	정기배송 상태 U:이용중 P:일시정지 C:해지
quantity	주문 수량
expected_delivery_date	배송예정일
subscription_shipments_cycle	배송주기 1W : 1주 2W : 2주 3W : 3주 4W : 4주 1M : 1개월 2M : 2개월 3M : 3개월 4M : 4개월 5M : 5개월 6M : 6개월 1Y : 1년

Update product variants in subscription

PUT /api/v2/admin/subscription/shipments/{subscription_id}/items

PUT

정기배송 품목별 수정을 할 수 있습니다.

기본스펙

Property	Description
SCOPE	주문 쓰기권한 (mall.write_order)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
subscription_id Required	정기배송 신청번호
variant_code Required 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드
option_id Required 형식 : [A-Z0-9] 글자수 최소: [4자]~최대: [11자]	상품옵션 아이디
subscription_state	정기배송 상태 U:이용중 P:일시정지 C:해지
quantity 최소값: [1]	주문 수량
expected_delivery_date 날짜	배송예정일
subscription_shipments_cycle	배송주기 1W : 1주 2W : 2주 3W : 3주 4W : 4주 1M : 1개월 2M : 2개월 3M : 3개월 4M : 4개월 5M : 5개월 6M : 6개월 1Y : 1년

Request Copy

Response Copy

Customergroups

회원등급(CustomerGroups)은 쇼핑몰 회원을 등급별로 검색하여 관리할 수 있습니다.
각 회원 등급 전체에게 메일, 적립금 지급, 선택한 회원의 등급 해제 및 변경을 할 수 있습니다.

Endpoints

GET /api/v2/admin/customergroups
GET /api/v2/admin/customergroups/count
GET /api/v2/admin/customergroups/{group_no}

Customergroups properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
group_no	회원등급번호
group_name	회원등급명
group_description	회원 등급설명
group_icon	회원등급 아이콘
benefits_paymethod	혜택 결제조건 A : 모든 결제 B : 현금 결제(무통장) C : 현금 결제 외 모든 결제
buy_benefits	구매시 할인/적립 혜택 F : 혜택없음 D : 구매금액 할인 M : 적립금 지급 P : 할인/적립 동시 적용
ship_benefits	배송비 혜택 T : 배송비무료설정 F : 배송비무료설정안함
product_availability	상품별 할인 중복설정 P : 상품별 가격할인만 적용 M : 회원등급별 가격할인만 적용 A : 둘다적용
discount_information	구매금액 할인설정
points_information	적립금 지급설정
mobile_discount_information	모바일 추가 할인설정
mobile_points_information	모바일 추가 적립금설정
discount_limit_information	할인 제한설정 멀티쇼핑몰에서 등급별 할인 혜택 제한 사용 시 등급 별로 적용되는 할인 혜택 제한 설정 및 최대 할인 한도 정보. 멀티쇼핑몰에서 등급별 할인 혜택 제한을 사용하지 않거나, buy_benefits(구매 시 할인/적립 혜택)이 F(혜택없음) 또는 M(적립금 지급)일 경우 null로 반환 discount_limit_type(할인 혜택 제한 설정) - A : 제한없음 - B : 할인금액 제한 - C : 할인횟수 제한 discount_amount_limit(최대 할인금액 한도) : discount_limit_type이 B가 아닐 경우 null number_of_discount_limit(최대 할인횟수 한도) : discount_limit_type이 C가 아닐 경우 null로 반환.

Retrieve a list of customer tiers

GET /api/v2/admin/customergroups

GET

쇼핑몰에 추가한 회원등급 속성을 목록으로 조회합니다.
회원등급번호, 회원등급명, 주매시 할인/적립 혜택 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

group_no

회원등급번호

,(콤마)로 여러 건을 검색할 수 있다.

group_name

최대글자수 : [20자]

회원등급명

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Retrieve a count of customer tiers

GET /api/v2/admin/customergroups/count

GET

쇼핑몰에 추가한 회원등급의 수를 조회합니다.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

group_no

회원등급번호

시스템이 회원등급에 부여한 번호.

,(콤마)로 여러 건을 검색할 수 있다.

group_name

최대글자수 : [20자]

회원등급명

회원등급을 만들 당시 지정한 회원등급의 이름.

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Retrieve a customer tier

GET /api/v2/admin/customergroups/{group_no}

GET

회원등급번호를 이용하여 해당 회원등급의 속성을 조회합니다.
회원등급명, 등급설명, 혜택 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

group_no
Required

회원등급번호

시스템이 회원등급에 부여한 번호.

Request Copy

Response Copy

Customergroups customers

회원등급의 회원(Customergroups customers)은 특정 회원등급의 회원과 관련된 기능입니다.
특정 회원을 특정 등급으로 변경할 수 있습니다.

Endpoints

POST /api/v2/admin/customergroups/{group_no}/customers

Customergroups customers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
group_no	회원등급번호
member_id	회원아이디
fixed_group	회원등급 고정 여부 특정 회원이 회원자동등급변경에 적용되지 않기 위한 등급 고정 여부. 회원자동등급변경 기능을 사용하는 몰에서만 사용 가능하다. T : 고정함 F : 고정안함

Update a customer's customer tier

POST /api/v2/admin/customergroups/{group_no}/customers

POST

특정 등급에 회원을 추가할 수 있습니다.
회원등급 고정여부는 회원자동등급변경 기능을 사용하는 몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	회원 쓰기권한 (mall.write_customer)
호출건수 제한	40
1회당 요청건수 제한	200

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
group_no Required	회원등급번호
member_id Required 최대글자수 : [20자]	회원아이디
fixed_group	회원등급 고정 여부 특정 회원이 회원자동등급변경에 적용되지 않기 위한 등급 고정 여부 회원자동등급변경 기능을 사용하는 몰에서만 사용 가능하다. T : 고정함 F : 고정안함 DEFAULT F

Request Copy

Response Copy

Customergroups setting

Endpoints

GET /api/v2/admin/customergroups/setting

Customergroups setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
auto_update	회원등급 자동변경 사용설정 T : 사용함 F : 사용안함
use_auto_update	회원등급 자동변경 적용여부 T : 적용함(사용중) F : 적용안함(사용대기)
customer_tier_criteria	회원 등급 기준 purchase_amount : 구매금액 purchase_count : 구매건수 purchase_amount_and_count : 구매금액과 구매건수 purchase_amount_or_count : 구매금액 또는 구매건수 shopping_index : 쇼핑지수
standard_purchase_amount	구매 금액 정의 total_order_amount : 총 주문 금액 total_paid_amount : 총 결제 금액 credit_price : 총실결제금액 + 예치금
offline_purchase_amount	오프라인 구매금액 포함여부 T : 포함 F : 미포함
standard_purchase_count	구매 건수 정의 order_count : 주문 횟수 product_count : 상품(품목) 개수
offline_purchase_count	오프라인 구매건수 포함여부 T : 포함 F : 미포함
auto_update_criteria	자동 변경 시 산정 주문 기준 설정 delivery_complete : 배송완료 기준 payment_complete : 결제완료 기준
deduct_cancellation_refund	취소/환불 금액(건) 차감 여부 T : 취소/환불 금액(건) 차감 F : 취소/환불 금액(건) 미차감
interval_auto_update	자동 변경 주기 1d : 매일 3d : 3일 1w : 1주 1m : 1개월 3m : 3개월 6m : 6개월 12m : 12개월
total_period	등급 산정 누적 기간 now : 변경시점 직전까지 1m : 최근 1개월 3m : 최근 3개월 6m : 최근 6개월 12m : 최근 12개월 24m : 최근 24개월 36m : 최근 36개월
interval_week	자동 변경일(매주) 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
interval_month	자동 변경일(매월) 1 : 1일 5 : 5일 10 : 10일 15 : 15일 20 : 20일 25 : 25일
auto_update_set_date	회원등급 변경 시점
use_discount_limit	등급별 할인 제한 사용여부 T : 사용함 F : 사용안함
discount_limit_reset_period	할인 제한 초기화 주기 1d : 매일 3d : 3일 1w : 1주 1m : 1개월
discount_limit_reset_week	할인 제한 초기화 일자(매주) 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
discount_limit_reset_date	할인 제한 초기화 일자(매월) 1 : 1일 5 : 5일 10 : 10일 15 : 15일 20 : 20일 25 : 25일
discount_limit_begin_date	할인 제한 시작 일자
discount_limit_end_date	할인 제한 종료 일자

Retrieve customer tier settings

GET /api/v2/admin/customergroups/setting

GET

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Customers

회원(Customers)은 쇼핑몰의 상품을 구매하는 고객들 중 쇼핑몰의 쿠폰, 적립금, 할인 등의 혜택을 받기 위해 가입한 고객들입니다.
회원 관리를 위해 쇼핑몰 운영자는 회원을 특정 회원 등급으로 분류하거나 특별회원으로 지정할 수 있습니다.

Endpoints

GET /api/v2/admin/customers
DELETE /api/v2/admin/customers/{member_id}

Customers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
member_id Required 최대글자수 : [20자]	회원아이디
group_no	회원등급번호 해당 회원의 회원등급의 번호
member_authentication	회원인증여부 회원 인증여부. 인증에 따라 회원은 4종류로 구분된다. 인증회원을 특별관리회원으로 설정할 경우 해당 회원은 가장 마지막에 설정한 특별관리회원으로 표시된다. T : 인증 F : 미인증 B : 특별관리회원 J : 14세미만회원
use_blacklist	불량회원설정 불량회원 여부. 불량회원일 경우 불량회원 타입에 따라 상품구매 차단, 로그인 차단, 로그인과 상품구매 모두를 차단할 수 있음. T : 설정함 F : 설정안함
blacklist_type	불량회원 차단설정 해당 회원의 불량회원 타입. 불량회원 타입에 따라 상품구매 차단, 로그인 차단, 로그인과 상품구매 모두를 차단할 수 있음. P : 상품구매차단 L : 로그인차단 A : 로그인&상품구매 차단
authentication_method	인증 수단 null : 인증안함 i : 아이핀인증 m : 휴대폰 본인인증 e : 이메일인증 d : 휴대폰 인증(중복 확인) a : 앱 인증(기타 인증)
sms	SMS 수신여부 SMS를 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. T : 수신 F : 수신안함
news_mail	뉴스메일 수신여부 이메일을 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. T : 수신 F : 수신안함
solar_calendar	양력여부 T : 양력 F : 음력
total_points	총 적립금
available_points	가용 적립금
used_points	사용 적립금
last_login_date	최근 접속일시 해당 회원의 최종 로그인 일시
gender	성별 해당 회원의 성별 M : 남자 F : 여자
use_mobile_app	모바일앱 사용여부 T : 사용 F : 사용안함
available_credits	가용 예치금
created_date	가입일
fixed_group	회원등급 고정 여부 특정 회원이 회원자동등급변경에 적용되지 않기 위한 등급 고정 여부 회원자동등급변경 기능을 사용하는 몰에서만 사용 가능하다. T : 고정함 F : 고정안함

Retrieve a list of customers

GET /api/v2/admin/customers

GET

쇼핑몰에 가입한 특정 회원들을 검색합니다.
검색할 회원의 휴대전화 또는 회원아이디가 검색 조건으로 지정되야합니다.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

cellphone

휴대전화

검색할 쇼핑몰 회원의 휴대전화번호. 개인정보 보호를 위해 전체 휴대전화번호를 입력해야 한다. cellphone 또는 member_id 중 하나는 반드시 검색 조건으로 지정되어야 한다.

,(콤마)로 여러 건을 검색할 수 있다.

member_id

최대글자수 : [20자]

회원아이디

검색할 쇼핑몰 회원의 아이디. 개인정보 보호를 위해 전체 아이디를 입력해야 합니다.cellphone 또는 member_id 중 하나는 반드시 검색 조건으로 지정되어야 한다.

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Delete an account

DELETE /api/v2/admin/customers/{member_id}

DELETE

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	회원 쓰기권한 (mall.write_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

member_id
Required

최대글자수 : [20자]

회원아이디

is_point_check

적립금보유회원 탈퇴 처리 여부

F : 탈퇴 안 함
T : 탈퇴 처리

Request Copy

Response Copy

Customers autoupdate

Endpoints

GET /api/v2/admin/customers/{member_id}/autoupdate

Customers autoupdate properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
member_id	회원아이디
next_grade	다음 예상 등급
total_purchase_amount	등급 산정 기간 내 누적 사용 금액
total_purchase_count	등급 산정 기간 내 누적 사용 건수
required_purchase_amount	다음 등급까지 필요 금액
required_purchase_count	다음 등급까지 필요 건수

Retrieve customer tier auto-update details

GET /api/v2/admin/customers/{member_id}/autoupdate

GET

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

member_id
Required

최대글자수 : [20자]

회원아이디

Request Copy

Response Copy

Customers memos

회원 메모(Customers memos)는 특정 회원의 메모에 대한 회원의 하위 리소스입니다.
회원 메모를 통해 특정 회원에 대하여 메모를 등록, 수정, 삭제 등을 할 수 있습니다.

Endpoints

GET /api/v2/admin/customers/{member_id}/memos/count
GET /api/v2/admin/customers/{member_id}/memos
GET /api/v2/admin/customers/{member_id}/memos/{memo_no}
POST /api/v2/admin/customers/{member_id}/memos
PUT /api/v2/admin/customers/{member_id}/memos/{memo_no}
DELETE /api/v2/admin/customers/{member_id}/memos/{memo_no}

Customers memos properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
memo_no	메모 번호 시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.
author_id	작성자 아이디 메모를 작성한 관리자의 아이디 정보.
memo	메모 내용 메모의 내용. HTML을 사용하여 등록할 수 있다.
important_flag	중요 메모 여부 중요 메모의 구분여부. T : 중요 메모 F : 일반 메모
created_date	생성일 메모를 작성한 시간.

Retrieve a count of customer memos

GET /api/v2/admin/customers/{member_id}/memos/count

GET

특정 회원의 메모 개수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

member_id
Required

회원아이디

Request Copy

Response Copy

Retrieve a list of customer memos

GET /api/v2/admin/customers/{member_id}/memos

GET

특정 회원에 대한 메모 목록을 조회할 수 있습니다.
작성자 아이디, 메모 내용, 중요 메모 여부 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
member_id Required	회원아이디
start_date 날짜	검색 시작일
end_date 날짜	검색 종료일
important_flag	중요 메모 여부 T : 중요 메모 F : 일반 메모
memo	메모
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Retrieve a customer memo

GET /api/v2/admin/customers/{member_id}/memos/{memo_no}

GET

특정 회원의 메모 1개를 조회할 수 있습니다.
메모의 작성자 아이디, 메모 내용 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

memo_no
Required

메모 번호

시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.

member_id
Required

회원아이디

Request Copy

Response Copy

Create a customer memo

POST /api/v2/admin/customers/{member_id}/memos

POST

특정 회원에 메모를 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 쓰기권한 (mall.write_customer)
호출건수 제한	30
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
member_id Required	회원아이디
author_id Required 최대글자수 : [20자]	작성자 아이디 메모를 작성한 관리자의 아이디 정보.
memo Required	메모 메모의 내용. HTML을 사용하여 등록할 수 있다.
important_flag	중요 메모 여부 중요 메모의 구분여부. T : 중요 메모 F : 일반 메모 DEFAULT F

Request Copy

Response Copy

Update a customer memo

PUT /api/v2/admin/customers/{member_id}/memos/{memo_no}

PUT

특정 회원에 등록된 메모를 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 쓰기권한 (mall.write_customer)
호출건수 제한	30
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shop_no	멀티쇼핑몰 번호 DEFAULT 1
memo_no Required	메모 번호 시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.
member_id Required	회원아이디
author_id Required 최대글자수 : [20자]	작성자 아이디 메모를 작성한 관리자의 아이디 정보.
memo	메모 메모의 내용. HTML을 사용하여 등록할 수 있다.
important_flag	중요 메모 여부 중요 메모의 구분여부. T : 중요 메모 F : 일반 메모

Request Copy

Response Copy

Delete a customer memo

DELETE /api/v2/admin/customers/{member_id}/memos/{memo_no}

DELETE

특정 회원에 등록된 메모를 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 쓰기권한 (mall.write_customer)
호출건수 제한	30

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

memo_no
Required

메모 번호

시스템에서 부여한 상품 메모의 고유한 번호. 상품 메모 번호는 쇼핑몰 내에서 중복되지 않는다.

member_id
Required

회원아이디

Request Copy

Response Copy

Customers paymentinformation

회원의 결제수단정보(Customers paymentinformation)는 회원이 결제한 결제수단에 대해 목록조회, 삭제가 가능합니다.

Endpoints

GET /api/v2/admin/customers/{member_id}/paymentinformation
DELETE /api/v2/admin/customers/{member_id}/paymentinformation

Customers paymentinformation properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
member_id 최대글자수 : [20자]	회원아이디
payment_method	결제수단명
payment_gateway	PG 이름
created_date	생성일

Retrieve a customer's list of payment methods

GET /api/v2/admin/customers/{member_id}/paymentinformation

GET

특정 회원이 사용한 결제수단의 내역을 목록으로 조회할 수 있습니다.
결제수단명, PG이름 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

member_id
Required

최대글자수 : [20자]

회원아이디

Request Copy

Response Copy

Delete customer's payment information

DELETE /api/v2/admin/customers/{member_id}/paymentinformation

DELETE

특정 회원이 사용한 결제수단의 내역을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	회원 쓰기권한 (mall.write_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

member_id
Required

최대글자수 : [20자]

회원아이디

Request Copy

Response Copy

Customers plusapp

Endpoints

GET /api/v2/admin/customers/{member_id}/plusapp

Customers plusapp properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
os_type	OS 타입
install_date	설치일
auto_login_flag	자동로그인 설정 여부
use_push_flag	알림 수신 여부

Retrieve app installation information

GET /api/v2/admin/customers/{member_id}/plusapp

GET

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

member_id
Required

회원아이디

Request Copy

Response Copy

회원의 SNS(Customers social)는 특정 회원에게 연동된 SNS 계정의 정보를 조회할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/customers/{member_id}/social

Attribute	Description
shop_no	멀티쇼핑몰 번호
member_id	회원아이디
social_name	연동 된 SNS명
social_member_code	연동 된 SNS 제공코드
linked_date	연동 날짜

GET /api/v2/admin/customers/{member_id}/social

GET

특정 회원에게 연동된 SNS 계정의 정보를 목록으로 조회할 수 있습니다.
연동 된 SNS명과 연동 날짜 등을 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	회원 읽기권한 (mall.read_customer)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

member_id
Required

회원아이디

Request Copy

Response Copy

Boards

게시판(Boards)은 상품리뷰나 상품문의 등 고객의 반응이 글로 게시되는 공간입니다.
게시판 리소스에서는 현재 쇼핑몰에 있는 게시판의 목록을 확인할 수 있습니다.

Endpoints

GET /api/v2/admin/boards

Boards properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
board_no	게시판 번호
board_type	게시판 분류 1 : 운영 2 : 일반 3 : 자료실 4 : 기타 5 : 상품 6 : 갤러리 7 : 1:1상담 11 : 한줄메모
board_name	게시판 이름
use_additional_board	게시판 추가여부 T : 추가게시판 F : 기본게시판
use_board	게시판 사용여부 T : 사용함 F : 사용안함
use_display	표시여부 T : 표시함 F : 표시안함
display_order	정렬 순서
attached_file	파일 첨부 T : 사용함 F : 사용안함
attached_file_size_limit	첨부파일용량제한 (Byte)
article_display_type	게시물 표시 A : 전체 게시물 표시 T : 첨부 파일이 있는 게시물만 표시 F : 첨부 파일이 없는 게시물만 표시
image_display	이미지 표시 T : 사용함 F : 사용안함
image_resize	리사이징할 이미지 폭 (px)

Retrieve a list of boards

GET /api/v2/admin/boards

GET

현재 쇼핑몰에 있는 게시판을 목록으로 조회할 수 있습니다.
게시판 번호를 조회하여 게시물 조회나 댓글 조회시 사용할 수 있습니다.
해당 API는 한국어, 일본어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Boards articles

게시물(Boards articles)은 게시판에 게시되는 게시물을 관리하기 위한 리소스입니다.
특정 게시판의 게시물을 조회하거나 게시물을 생성하거나 수정, 삭제할 수 있습니다.

Endpoints

GET /api/v2/admin/boards/{board_no}/articles
POST /api/v2/admin/boards/{board_no}/articles
PUT /api/v2/admin/boards/{board_no}/articles/{article_no}
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

Boards articles properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
article_no 최대값: [2147483647]	게시물 번호
parent_article_no	부모 게시물 번호
board_no Required	게시판 번호
product_no	상품번호
category_no	분류 번호
board_category_no	게시판 카테고리 번호
reply_sequence	답변 게시물 순서
reply_depth	답변 차수
created_date 날짜	생성일
writer	작성자명
writer_email 이메일	작성자 이메일
member_id	회원아이디
title	제목
content	내용
supplier_id 형식 : [a-z0-9] 글자수 최소: [4자]~최대: [16자]	공급사 아이디
client_ip IP	작성자 IP
nick_name	별명
rating 최소: [1]~최대: [5]	평점
sales_channel 최대글자수 : [20자]	매체사
reply_mail	1:1 게시판 문의내용에 대한 답변 메일 여부 Y : 사용함 N : 사용안함
display	게시 여부 T : 게시함 F : 게시안함
secret	비밀글 여부 T : 사용함 F : 사용안함
notice	공지 여부 T : 사용함 F : 사용안함
fixed	고정글 여부 T : 사용함 F : 사용안함
deleted	삭제 구분 T : 삭제 F : 비삭제
input_channel	게시물 작성 경로 P : PC M : 모바일
order_id	주문번호
attach_file_urls	첨부 파일 상세
hit	조회수
reply	1:1 게시판 문의내용에 대한 답변여부 T : 사용함 F : 사용안함
reply_user_id	처리중 또는 답변완료 한 운영자 아이디
reply_status	답변 처리 상태 N : 답변전 P : 처리중 C : 처리완료
naverpay_review_id	네이버페이 리뷰 아이디
display_time	노출시간 사용여부
display_time_start_hour	노출시간 시작 시각
display_time_end_hour	노출시간 종료 시각
attached_file_detail	첨부 파일 상세
attached_file_urls	첨부 파일 상세

Retrieve a list of posts for a board

GET /api/v2/admin/boards/{board_no}/articles

GET

특정 게시판의 게시물 목록을 조회할 수 있습니다.
해당 API는 한국어, 일본어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
board_category_no	게시판 카테고리 번호
start_date 날짜	검색 시작일(작성일) 검색을 시작할 기준일 또는 작성일
end_date 날짜	검색 종료일 검색을 종료할 기준일 검색 시작일과 같이 사용해야함. 검색기간은 한 호출에 1년 이상 검색 불가.
input_channel	쇼핑몰 구분 P : PC M : 모바일
search	검색 영역 subject : 제목 content : 내용 writer_name : 작성자 product : 상품명 member_id : 회원 아이디
keyword	검색어
reply_status	답변상태 N : 답변 전 P : 처리중 C : 답변 완료
comment	댓글여부 T : 있음 F : 없음
attached_file	첨부파일 여부 T : 있음 F : 없음
article_type	게시물 유형 ,(콤마)로 여러 건을 검색할 수 있다. all : 전체 normal : 일반글 notice : 공지글 fixed : 고정글
product_no	상품번호
has_product	상품정보 포함 여부 T : 있음 F : 없음
is_notice	공지 여부 T : 있음 F : 없음
is_display	게시 여부 T : 있음 F : 없음
supplier_id 형식 : [a-z0-9] 글자수 최소: [4자]~최대: [16자]	공급사 아이디
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Create a board post

POST /api/v2/admin/boards/{board_no}/articles

POST

특정 게시판에 게시물을 등록할 수 있습니다.
해당 게시판이 상품 게시판일 경우 평점과 같은 정보도 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	게시판 쓰기권한 (mall.write_community)
호출건수 제한	40
1회당 요청건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
writer Required 최대글자수 : [100자]	작성자명
title Required 최대글자수 : [256자]	제목
content Required	내용
client_ip Required IP	작성자 IP
reply_article_no	답변 게시물 번호 게시물에 답변을 추가하고자 할 경우 게시물의 번호를 입력한다.
created_date 날짜	생성일
writer_email 이메일	작성자 이메일
member_id 최대글자수 : [20자]	회원아이디 미입력시 대표운영자 계정으로 작성된다.
notice	공지 여부 T : 사용함 F : 사용안함 DEFAULT F
fixed	고정글 여부 T : 사용함 F : 사용안함 DEFAULT F
deleted	삭제 구분 T : 삭제 F : 비삭제 DEFAULT F
reply	1:1 게시판 문의내용에 대한 답변여부 T : 사용함 F : 사용안함 DEFAULT F
rating 최소: [1]~최대: [5]	평점
sales_channel 최대글자수 : [20자]	매체사
secret	비밀글 여부 T : 사용함 F : 사용안함 DEFAULT F
password	게시글 비밀번호
reply_mail	1:1 게시판 문의내용에 대한 답변 메일 여부 Y : 사용함 N : 사용안함 DEFAULT N
board_category_no	게시판 카테고리 번호
nick_name 최대글자수 : [50자]	별명
input_channel	게시물 작성 경로 P : PC M : 모바일 DEFAULT P
reply_user_id	처리중 또는 답변완료 한 운영자 아이디
reply_status	답변 처리 상태 N : 답변전 P : 처리중 C : 처리완료
product_no 최대값: [2147483647]	상품번호
category_no	분류 번호
order_id 주문번호	주문번호
naverpay_review_id	네이버페이 리뷰 아이디
attach_file_urls	첨부 파일 상세
name 파일명 url 파일 URL

Request Copy

Response Copy

Update a board post

PUT /api/v2/admin/boards/{board_no}/articles/{article_no}

PUT

특정 게시판의 게시물을 수정할 수 있습니다.
게시물의 제목, 내용과 평점, 노출 시간 등의 정보를 수정할 수 있습니다.
해당 API는 한국어, 일본어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	게시판 쓰기권한 (mall.write_community)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
article_no Required	게시물 번호
title 최대글자수 : [256자]	제목
content	내용
rating 최소: [1]~최대: [5]	평점
sales_channel 최대글자수 : [20자]	매체사
board_category_no	게시판 카테고리 번호
display	게시 여부 T : 게시함 F : 게시안함
notice	공지 여부 T : 사용함 F : 사용안함
fixed	고정글 여부 T : 사용함 F : 사용안함
display_time_start_hour	노출시간 시작 시각
display_time_end_hour	노출시간 종료 시각
attach_file_url1 URL	파일 URL
attach_file_url2 URL	파일 URL
attach_file_url3 URL	파일 URL
attach_file_url4 URL	파일 URL
attach_file_url5 URL	파일 URL

Request Copy

Response Copy

Delete a board post

DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

DELETE

특정 게시판에 있는 게시물 하나를 삭제할 수 있습니다.
해당 API는 한국어, 일본어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	게시판 쓰기권한 (mall.write_community)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

board_no
Required

게시판 번호

article_no
Required

최대값: [2147483647]

게시물 번호

Request Copy

Response Copy

Boards articles comments

댓글(Comments)은 게시물에 쇼핑몰 고객이나 관리자가 추가한 의견입니다.
해당 리소스를 통해 특정 게시물에 달린 댓글을 추가/삭제하거나 조회할 수 있습니다

Endpoints

GET /api/v2/admin/boards/{board_no}/articles/{article_no}/comments
POST /api/v2/admin/boards/{board_no}/articles/{article_no}/comments
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}/comments/{comment_no}

Boards articles comments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
board_no	게시판 번호
article_no	게시물 번호
comment_no	댓글 번호
content	댓글 내용
writer 최대글자수 : [100자]	작성자명
member_id 최대글자수 : [20자]	회원아이디
created_date 날짜	생성일
client_ip IP	작성자 IP
rating 최소: [1]~최대: [5]	댓글 평점
secret	비밀글 여부 T : 사용함 F : 사용안함
parent_comment_no	부모 댓글 번호
input_channel	쇼핑몰 구분 P : PC M : 모바일
attach_file_urls	첨부 파일 상세

Retrieve a list of comments for a board post

GET /api/v2/admin/boards/{board_no}/articles/{article_no}/comments

GET

특정 게시물에 달린 댓글을 조회할 수 있습니다.
댓글 내용, 작성자명, 회원아이디 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
article_no Required	게시물 번호
comment_no	댓글 번호
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Create a comment for a board post

POST /api/v2/admin/boards/{board_no}/articles/{article_no}/comments

POST

특정 게시물에 댓글을 추가할 수 있으며, 댓글에 댓글을 추가할 수도 있습니다.
게시물 번호, 댓글 내용 등을 필수로 입력합니다.

기본스펙

Property	Description
SCOPE	게시판 쓰기권한 (mall.write_community)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
article_no Required	게시물 번호
content Required	댓글 내용
writer Required 최대글자수 : [100자]	작성자명
password Required 글자수 최소: [1자]~최대: [20자]	댓글 비밀번호
member_id 최대글자수 : [20자]	회원아이디
rating 최소: [1]~최대: [5]	댓글 평점 DEFAULT 0
secret	비밀글 여부 T : 사용함 F : 사용안함 DEFAULT F
parent_comment_no 최소값: [1]	부모 댓글 번호
input_channel	쇼핑몰 구분 P : PC M : 모바일 DEFAULT P
created_date 날짜	생성일
attach_file_urls	첨부 파일 상세
name 파일명 url 파일 URL

Request Copy

Response Copy

Delete a comment for a board post

DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}/comments/{comment_no}

DELETE

특정 게시물에 달린 댓글을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	게시판 쓰기권한 (mall.write_community)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
article_no Required	게시물 번호
comment_no Required	댓글 번호

Request Copy

Response Copy

Boards comments

Endpoints

GET /api/v2/admin/boards/{board_no}/comments

Boards comments properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
board_no	게시판 번호
article_no	게시물 번호
comment_no	댓글 번호
content	댓글 내용
writer 최대글자수 : [100자]	작성자명
member_id 최대글자수 : [20자]	회원아이디
created_date 날짜	생성일
client_ip IP	작성자 IP
rating 최소: [1]~최대: [5]	댓글 평점
secret	비밀글 여부 T : 사용함 F : 사용안함
parent_comment_no	부모 댓글 번호
input_channel	쇼핑몰 구분 P : PC M : 모바일
attach_file_urls	첨부 파일 상세
links	link

Retrieve comments in bulk

GET /api/v2/admin/boards/{board_no}/comments

GET

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
board_no Required	게시판 번호
since_comment_no 최소값: [1] 최대값: [2147483647]	해당 댓글번호 이후 검색
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Financials monthlyreviews

월별 리뷰 통계(Financials monthlyreviews)는 월별 리뷰 정보를 제공합니다.
검색 기간 내의 월별 리뷰 개수 합계, 월별 리뷰 평점 평균을 확인할 수 있습니다.

Endpoints

GET /api/v2/admin/financials/monthlyreviews

Financials monthlyreviews properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
month	년월
count	리뷰 개수 합계
rating_average	리뷰 평점 평균

Retrieve the total count for monthly reviews and ratings

GET /api/v2/admin/financials/monthlyreviews

GET

검색 기간 내의 월별 리뷰 정보를 조회합니다.
월별 리뷰 개수 합계, 월별 리뷰 평점 평균을 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

start_month
Required

검색 시작월

end_month
Required

검색 종료월

Request Copy

Response Copy

Urgentinquiry

긴급문의 게시물에 대해 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/urgentinquiry

Urgentinquiry properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
article_no	게시물 번호
article_type	게시물 유형
title	제목
writer	작성자명
member_id	회원아이디
start_date 날짜	작성일 시작일자
reply_status	답변 처리 상태 F: 미처리 I: 처리중 T: 처리완료
hit	조회수
content	내용
writer_email 이메일	작성자 이메일
phone 전화번호	전화번호
search_type	검색 타입 P:상품 O:주문
keyword	검색어
attached_file_detail	첨부 파일 상세

Retrieve an urgent inquiry post

GET /api/v2/admin/urgentinquiry

GET

긴급문의 게시물을 조회합니다.
게시물 유형, 답변 처리 상태, 조회수 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
start_date 날짜	작성일 시작일자
end_date 날짜	작성일 종료일자
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Urgentinquiry reply

긴급문의 게시물의 답변글을 조회, 등록, 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/urgentinquiry/{article_no}/reply
POST /api/v2/admin/urgentinquiry/{article_no}/reply
PUT /api/v2/admin/urgentinquiry/{article_no}/reply

Urgentinquiry reply properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
article_no	게시물 번호
created_date 날짜	답변 등록일
status	답변 처리 상태 F: 미처리 I: 처리중 T: 처리완료
content	답변 내용
method	답변 방법 E:이메일 S:SMS A:전부
count	답변 처리 횟수
user_id	처리중 또는 답변완료 한 운영자 아이디
attached_file_detail	첨부 파일 상세

Retrieve a reply for urgent inquiry post

GET /api/v2/admin/urgentinquiry/{article_no}/reply

GET

긴급문의 게시물의 답변글을 조회합니다.
답변 등록일, 답변 처리 상태, 답변 처리 횟수 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	게시판 읽기권한 (mall.read_community)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

article_no
Required

게시물 번호

Request Copy

Response Copy

Create a reply for urgent inquiry post

POST /api/v2/admin/urgentinquiry/{article_no}/reply

POST

긴급문의 게시물에 답변글을 등록합니다.

기본스펙

Property	Description
SCOPE	게시판 쓰기권한 (mall.write_community)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
article_no Required	게시물 번호
content Required	답변 내용
status	답변 처리 상태 F: 미처리 I: 처리중 T: 처리완료 DEFAULT F
user_id Required 최대글자수 : [20자]	처리중 또는 답변완료 한 운영자 아이디
attach_file_urls	첨부 파일 상세
name Required 파일명 url Required 파일 URL

Request Copy

Response Copy

Update a reply for urgent inquiry post

PUT /api/v2/admin/urgentinquiry/{article_no}/reply

PUT

긴급문의 게시물의 답변글을 수정합니다.

기본스펙

Property	Description
SCOPE	게시판 쓰기권한 (mall.write_community)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
article_no Required	게시물 번호
content Required	답변 내용
status	답변 처리 상태 F: 미처리 I: 처리중 T: 처리완료
user_id 최대글자수 : [20자]	처리중 또는 답변완료 한 운영자 아이디
attach_file_urls	첨부 파일 상세
name Required 파일명 url Required 파일 URL

Request Copy

Response Copy

Icons

디자인 아이콘은 상품, 게시판, 이벤트, 카드, 결제수단 로고로 사용 중인 작은 이미지입니다.
PC 쇼핑몰과 모바일 쇼핑몰의 아이콘을 모두 확인할 수 있습니다.

Endpoints

GET /api/v2/admin/icons

Icons properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
id	아이콘 아이디
type	디자인 타입 pc : PC mobile : 모바일
group_code	그룹 코드 A : 상품 아이콘 B : 게시판 아이콘 C : 카드 아이콘 E : 이벤트 아이콘
path	아이콘 URL
display	아이콘 노출여부 T : 노출함 F : 노출안함
description	아이콘 설명

Retrieve a list of desgin icons

GET /api/v2/admin/icons

GET

PC와 모바일 쇼핑몰에서 사용하는 아이콘을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	디자인 읽기권한 (mall.read_design)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

type

디자인 타입

pc : PC
mobile : 모바일

DEFAULT pc

Request Copy

Response Copy

Themes

디자인(Themes)은 쇼핑몰에 사용하기 위해 구매하거나 혹은 직접 만든 디자인과 관련된 기능입니다.
PC 쇼핑몰과 모바일 쇼핑몰의 디자인을 모두 확인할 수 있습니다.
디자인 목록에 있는 디자인 중 대표 디자인을 지정하면 쇼핑몰의 디자인이 해당 디자인으로 변경됩니다.

Endpoints

GET /api/v2/admin/themes
GET /api/v2/admin/themes/count
GET /api/v2/admin/themes/{skin_no}

Themes properties

Attribute	Description
skin_no 최소값: [1]	디자인 번호
skin_code	디자인 코드
skin_name 최대글자수 : [100자]	디자인명
skin_thumbnail_url 최대글자수 : [255자]	디자인 썸네일 이미지 URL
usage_type	디자인 용도 구분 S : PC 기본스킨 C : PC 복사된 스킨 I : PC 상속된 스킨 M : 모바일 기본스킨/상속된 스킨 N : 모바일 복사된 스킨
editor_type	에디터 타입 H : 스마트 디자인 (HTML) D : 에디봇 디자인 (Drag & Drop) W : 심플 디자인 (WYSIWYG) E : 스마트디자인Easy
parent_skin_no	부모 디자인 번호
seller_id	판매자 디자인센터 아이디
seller_skin_code	판매자 디자인 코드
design_purchase_no 최소값: [0]	디자인 구매 번호
design_product_code	디자인센터 상품 코드
language_code 최소글자수 : [5자] 최대글자수 : [5자]	언어 코드 ko_KR : 국문 en_US : 영문 zh_CN : 중문(간체) zh_TW : 중문(번체) ja_JP : 일문 pt_PT : 포르투갈어 es_ES : 스페인어 vi_VN : 베트남어
published_in	대표디자인 설정 멀티쇼핑몰 번호
created_date 날짜	생성일
updated_date 날짜	수정일
preview_domain	도메인 조회

Retrieve a list of themes

GET /api/v2/admin/themes

GET

PC 쇼핑몰 혹은 모바일 쇼핑몰의 전체 디자인들의 정보를 목록으로 조회할 수 있습니다.
디자인코드, 디자인명, 언어코드 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	디자인 읽기권한 (mall.read_design)
호출건수 제한	40

요청사양

Parameter

Description

type
Required

디자인 타입

pc : PC
mobile : 모바일

DEFAULT pc

Request Copy

Response Copy

Retrieve a count of themes

GET /api/v2/admin/themes/count

GET

쇼핑몰의 디자인의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	디자인 읽기권한 (mall.read_design)
호출건수 제한	40

요청사양

Parameter	Description
type	디자인 타입 pc : PC mobile : 모바일 DEFAULT pc

Request Copy

Response Copy

Retrieve a theme

GET /api/v2/admin/themes/{skin_no}

GET

쇼핑몰의 특정 스킨번호(디자인 번호)의 정보를 조회할 수 있습니다.
디자인코드, 디자인명 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	디자인 읽기권한 (mall.read_design)
호출건수 제한	40

요청사양

Parameter	Description
skin_no 최소값: [1]	디자인 번호

Request Copy

Response Copy

Themes pages

테마 페이지(Themes pages)는 쇼핑몰의 디자인 테마의 페이지에 대한 조회, 설정, 수정, 삭제를 하는 기능입니다.
테마 페이지는 하위 리소스로 테마(Themes) 하위에서만 사용할 수 있습니다.

Endpoints

GET /api/v2/admin/themes/{skin_no}/pages
POST /api/v2/admin/themes/{skin_no}/pages

Themes pages properties

Attribute	Description
skin_no	디자인 번호
skin_code	디자인 코드
path	파일 경로
source	소스 코드
display_location	화면 분류

Retrieve a theme page

GET /api/v2/admin/themes/{skin_no}/pages

GET

스킨을 지정한 테마 페이지를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	디자인 읽기권한 (mall.read_design)
호출건수 제한	40

요청사양

Parameter	Description
skin_no Required	디자인 번호
path Required	파일 경로

Request Copy

Response Copy

Create a theme page

POST /api/v2/admin/themes/{skin_no}/pages

POST

테마 페이지를 설정합니다.
디자인 테마를 특정 경로에 설정할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	디자인 쓰기권한 (mall.write_design)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
skin_no Required	디자인 번호
path Required	파일/디렉토리 경로
source	소스 코드
display_location	화면 분류

Request Copy

Response Copy

Benefits

혜택(Benefits)은 쇼핑몰 고객에게 제공하는 증정 또는 할인과 같은 고객 혜택입니다.
혜택 리소스를 통해 고객에게 증정 또는 할인 등의 프로모션을 생성하거나 수정, 삭제할 수 있고 생성되어있는 혜택 정보를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/benefits
GET /api/v2/admin/benefits/count
GET /api/v2/admin/benefits/{benefit_no}
POST /api/v2/admin/benefits
PUT /api/v2/admin/benefits/{benefit_no}
DELETE /api/v2/admin/benefits/{benefit_no}

Benefits properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호
benefit_no	혜택번호 혜택이 생성된 경우 부여되는 고유 번호
use_benefit	진행여부
benefit_name 최대글자수 : [255자]	혜택명
benefit_division	혜택 유형 해당 혜택의 유형으로, 할인과 증정으로 구분됨
benefit_type	혜택 상세유형 해당 혜택의 상세유형 할인 : 기간할인, 재구매할인, 대량구매할인, 회원할인, 신규상품할인, 배송비할인 증정 : 사은품증정, 1+N 이벤트
use_benefit_period	혜택 기간 설정 해당 혜택이 적용되는 기간을 설정했는지 여부
benefit_start_date 날짜	혜택 시작일 혜택이 적용되는 기간을 설정한 경우, 해당 혜택이 시작되는 일시
benefit_end_date 날짜	혜택 종료일 혜택이 적용되는 기간을 설정한 경우, 해당 혜택이 종료되는 일시
platform_types	혜택 사용범위 해당 혜택이 적용되는 범위 (PC, 모바일, 플러스앱)
use_group_binding	참여대상 설정 해당 혜택이 적용되는 대상을 설정 (회원+비회원, 비회원, 회원)
customer_group_list	회원 등급 참여대상을 회원으로 설정한 경우, 참여가 가능한 회원등급을 설정
product_binding_type	상품 범위 해당 혜택이 적용되는 상품의 범위 전체상품 : 전체 상품에 혜택 적용 특정상품 : 선택한 특정 상품에 대해서만 혜택 적용 제외상품 : 선택한 특정 상품에 대해서만 혜택 적용 제외 상품분류 : 선택한 상품 분류에 속한 상품에 대해서만 혜택 적용
use_except_category	상품분류 혜택제외 특정 상품분류에 대해 혜택 적용을 제외함 (각 유형별로 설정 가능여부가 다름) 기간할인 : 전체상품, 특정상품인 경우 설정 가능 신규상품할인 : 전체상품인 경우 설정 가능 그 외 할인 및 증정유형에서는 설정 불가
available_coupon	쿠폰 사용범위 쿠폰이 있는 경우, 쿠폰을 중복하여 사용할 수 있는지 여부
icon_url	아이콘 URL 혜택이 적용되는 상품명에 아이콘이 노출되도록 아이콘 등록
created_date	혜택 등록일 해당 혜택이 등록된 일시
period_sale	기간 할인 설정 혜택의 상세유형이 기간 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함
repurchase_sale	재구매 할인 설정 혜택의 상세유형이 재구매 할인인 경우 그와 관련한 상세 설정
bulk_purchase_sale	대량구매 수량 설정 혜택의 상세유형이 대량구매 할인인 경우 그와 관련한 상세 설정
member_sale	회원 할인 설정 혜택의 상세유형이 회원 할인인 경우 그와 관련한 상세 설정
new_product_sale	신규상품할인 설정 혜택의 상세유형이 신규상품 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함
shipping_fee_sale	배송비 할인 설정 혜택의 상세유형이 배송비 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함
gift	사은품 설정 혜택의 상세유형이 사은품 증정인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함
gift_product_bundle	1+N 이벤트 설정 혜택의 상세유형이 1+N 이벤트인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함

Retrieve a list of customer benefits

GET /api/v2/admin/benefits

GET

혜택을 목록으로 조회할 수 있습니다.
혜택의 진행여부, 혜택명, 혜택유형 등을 조회할 수 있습니다.
현재 진행중인 혜택만 조회하거나 특정 기간을 통해 혜택을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	프로모션 읽기권한 (mall.read_promotion)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호 DEFAULT 1
use_benefit	진행여부 T : 진행함 F : 진행안함
benefit_name	혜택명
benefit_type	혜택 상세유형 해당 혜택의 상세유형 DP : 기간할인 DR : 재구매할인 DQ : 대량구매할인 DM : 회원할인 DN : 신규상품할인 DV : 배송비할인 PG : 사은품 PB : 1+N 이벤트
period_type	혜택 기간 타입 R : 혜택 등록일 S : 혜택 시작일 E : 혜택 종료일
benefit_start_date 날짜	검색 시작일
benefit_end_date 날짜	검색 종료일
platform_types	혜택 사용범위 ,(콤마)로 여러 건을 검색할 수 있다. P : PC 쇼핑몰 M : 모바일쇼핑몰 A : 플러스앱
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of customer benefits

GET /api/v2/admin/benefits/count

GET

혜택의 수를 조회할 수 있습니다.
현재 진행중인 혜택만 조회하거나 특정 기간을 통해 혜택을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	프로모션 읽기권한 (mall.read_promotion)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호 DEFAULT 1
use_benefit	진행여부 T : 진행함 F : 진행안함
benefit_name	혜택명
benefit_type	혜택 상세유형 해당 혜택의 상세유형 DP : 기간할인 DR : 재구매할인 DQ : 대량구매할인 DM : 회원할인 DN : 신규상품할인 DV : 배송비할인 PG : 사은품 PB : 1+N 이벤트
period_type	혜택 기간 타입 R : 혜택 등록일 S : 혜택 시작일 E : 혜택 종료일
benefit_start_date 날짜	검색 시작일
benefit_end_date 날짜	검색 종료일
platform_types	혜택 사용범위 ,(콤마)로 여러 건을 검색할 수 있다. P : PC 쇼핑몰 M : 모바일쇼핑몰 A : 플러스앱

Request Copy

Response Copy

Retrieve a customer benefit

GET /api/v2/admin/benefits/{benefit_no}

GET

특정 혜택을 상세 조회할 수 있습니다.
목록 조회에서는 제공되지 않는 기간할인, 회원 할인 등의 상세 설정을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	프로모션 읽기권한 (mall.read_promotion)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

benefit_no
Required

혜택번호

혜택이 생성된 경우 부여되는 고유 번호

Request Copy

Response Copy

Create a customer benefit

POST /api/v2/admin/benefits

POST

혜택을 새롭게 생성할 수 있습니다.
할인 또는 증정 중에 선택할 수 있으며 혜택 대상과 할인 기간 등을 선택할 수 있습니다.

기본스펙

Property	Description
SCOPE	프로모션 쓰기권한 (mall.write_promotion)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호 DEFAULT 1
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호 DEFAULT 1
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호
use_benefit Required	진행여부 T : 진행함 F : 진행안함
benefit_name Required 최대글자수 : [255자]	혜택명
benefit_division Required	혜택 유형 해당 혜택의 유형으로, 할인과 증정으로 구분됨 D : 할인 P : 증정
benefit_type Required	혜택 상세유형 해당 혜택의 상세유형 DP : 기간할인 DN : 신규상품할인 DV : 배송비 할인 PG : 사은품 PB : 1+N 이벤트
use_benefit_period	혜택 기간 설정 해당 혜택이 적용되는 기간을 설정할지 여부 사용함으로 설정하는 경우, 혜택 시작일과 종료일을 입력해야 함 T : 사용함 F : 사용안함
benefit_start_date 날짜	혜택 시작일 혜택이 적용되는 기간을 설정한 경우, 해당 혜택이 시작되는 일시
benefit_end_date 날짜	혜택 종료일 혜택이 적용되는 기간을 설정한 경우, 해당 혜택이 종료되는 일시
platform_types Required	혜택 사용범위 해당 혜택이 적용되는 범위 P : PC 쇼핑몰 M : 모바일쇼핑몰 A : 플러스앱
use_group_binding	참여대상 설정 해당 혜택이 적용되는 대상을 설정 A : 회원 + 비회원 N : 비회원 M : 회원
customer_group_list	회원 등급 참여대상을 회원으로 설정한 경우, 참여가 가능한 회원등급을 설정
product_binding_type	상품 범위 해당 혜택이 적용되는 상품의 범위 A : 전체상품 P : 특정상품 E : 제외상품 C : 상품분류
use_except_category	상품분류 혜택제외 특정 상품분류에 대해 혜택 적용을 제외함 (각 유형별로 설정 가능여부가 다름) 기간할인 : 전체상품, 특정상품인 경우 설정 가능 신규상품할인 : 전체상품인 경우 설정 가능 그 외 할인 및 증정유형에서는 설정 불가 T : 사용함 F : 사용안함
available_coupon	쿠폰 사용범위 쿠폰이 있는 경우, 쿠폰을 중복하여 사용할 수 있는지 여부 T : 모든 쿠폰 사용가능 F : 모든 쿠폰 사용제한
period_sale	기간 할인 설정 혜택의 상세유형이 기간 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함 할인 금액(discount_value_unit)이 비율(P)인 경우 할인 반올림 단위(discount_truncation_unit), 할인 단위 처리(discount_truncation_method) 필수 입력 할인 금액(discount_value_unit)이 금액(W)인 경우 discount_purchasing_quantity 필수 입력
product_list 상품 목록 add_category_list 상품 분류 except_category_list 제외 분류 discount_purchasing_quantity 할인 구매수량 T : 구매수량에 따라 F : 구매수량에 관계없이 discount_value 할인 값 discount_value_unit 할인 기준 P : 비율 W : 금액 discount_truncation_unit 할인 반올림 단위 F : 절사안함 C : 0.01 B : 0.1 O : 1 T : 10 M : 100 H : 1000 discount_truncation_method 할인 단위 처리 L : 내림 U : 반올림 C : 올림
gift	사은품 설정 혜택의 상세유형이 사은품 증정인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함
product_list 상품 목록 add_category_list 상품 분류 offer_only_first 첫 구매 여부 T : 사용함 F : 사용안함 first_purchase_type 첫 구매 기준 O : 주문기준 D : 배송완료 기준 use_unlimited_price 최대가격 제한여부 T : 사용함 F : 사용안함 purchase_start_price 구매가격 제한 (n 이상) purchase_limit_price 구매가격 제한 (n 미만) gift_product_list Array product_no 상품번호 gift_point 차감 점수 max_count 최대 선택 수량
new_product_sale	신규상품할인 설정 혜택의 상세유형이 신규상품 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함 할인 금액(discount_value_unit)이 비율(P)인 경우 할인 반올림 단위(discount_truncation_unit), 할인 단위 처리(discount_truncation_method) 필수 입력 할인 금액(discount_value_unit)이 금액(W)인 경우 discount_purchasing_quantity 필수 입력
product_list 상품 목록 add_category_list 상품 분류 except_category_list 제외 분류 new_product_date_type Required 신상품 설정 기준일 I : 상품 등록일 U : 상품 최종 수정일 V : 상품 최종 진열일 new_product_day Required 신상품 설정 값 new_product_term_type Required 신상품 설정 단위 D : 일 H : 시간 discount_purchasing_quantity 할인 구매수량 T : 구매수량에 따라 F : 구매수량에 관계없이 discount_value Required 할인 값 discount_value_unit 할인 기준 P : 비율 W : 금액 discount_truncation_unit 할인 반올림 단위 F : 절사안함 C : 0.01 B : 0.1 O : 1 T : 10 M : 100 H : 1000 discount_truncation_method 할인 단위 처리 L : 내림 U : 반올림 C : 올림
shipping_fee_sale	배송비 할인 설정 혜택의 상세유형이 배송비 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함
product_list 상품 목록 use_purchase_price_condition 금액 기준 사용여부 T : 사용함 F : 사용안함 total_purchase_price 금액 제한 include_regional_shipping_rate 지역별배송비 포함여부값 T : 포함 F : 미포함
gift_product_bundle	1+N 이벤트 설정 혜택의 상세유형이 1+N 이벤트인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 등록이 가능함
product_list 상품 목록 product_bundle_type Required 혜택 설정 P : 상품 I : 품목 product_bundle_count Required 추가 상품 수량
icon_url	아이콘 URL 혜택이 적용되는 상품명에 아이콘이 노출되도록 아이콘 등록

Request Copy

Response Copy

Update a customer benefit

PUT /api/v2/admin/benefits/{benefit_no}

PUT

특정 혜택을 수정할 수 있습니다.
할인 유형을 제외하고 혜택 기간이나 진행 여부, 혜택 명 등의 세부 정보를 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	프로모션 쓰기권한 (mall.write_promotion)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호 DEFAULT 1
benefit_no Required	혜택번호 혜택이 생성된 경우 부여되는 고유 번호
use_benefit	진행여부 T : 진행함 F : 진행안함
benefit_name 최대글자수 : [255자]	혜택명
use_benefit_period	혜택 기간 설정 해당 혜택이 적용되는 기간을 설정할지 여부 T : 사용함 F : 사용안함
benefit_start_date 날짜	혜택 시작일 혜택이 적용되는 기간을 설정한 경우, 해당 혜택이 시작되는 일시 혜택 시작일을 수정하고자 하는 경우, use_benefit_period 파라미터를 반드시 선언해야 함
benefit_end_date 날짜	혜택 종료일 혜택이 적용되는 기간을 설정한 경우, 해당 혜택이 종료되는 일시 혜택 종료일을 수정하고자 하는 경우, use_benefit_period 파라미터를 반드시 선언해야 함
platform_types	혜택 사용범위 해당 혜택이 적용되는 범위 P : PC 쇼핑몰 M : 모바일쇼핑몰 A : 플러스앱
use_group_binding	참여대상 설정 해당 혜택이 적용되는 대상을 설정 A : 회원 + 비회원 N : 비회원 M : 회원
customer_group_list	회원 등급 참여대상을 회원으로 설정한 경우, 참여가 가능한 회원등급을 설정 회원 등급을 수정하고자 하는 경우, use_group_binding 파라미터를 반드시 선언해야 함
product_binding_type	상품 범위 해당 혜택이 적용되는 상품의 범위 상품 범위가 P,E,C 인 경우 기존에 설정된 상품 또는 분류를 수정하고자 하는 경우 product_binding_type 파라미터를 반드시 선언해야 함 A : 전체상품 P : 특정상품 E : 제외상품 C : 상품분류
use_except_category	상품분류 혜택제외 특정 상품분류에 대해 혜택 적용을 제외함 (각 유형별로 설정 가능여부가 다름) 기간할인 : 전체상품, 특정상품인 경우 설정 가능 신규상품할인 : 전체상품인 경우 설정 가능 그 외 할인 및 증정유형에서는 설정 불가 기존에 설정된 제외 분류를 수정하고자 하는 경우, use_except_category 파라미터를 반드시 선언해야 함 T : 사용함 F : 사용안함
available_coupon	쿠폰 사용범위 쿠폰이 있는 경우, 쿠폰을 중복하여 사용할 수 있는지 여부 T : 모든 쿠폰 사용가능 F : 모든 쿠폰 사용제한
period_sale	기간 할인 설정 혜택의 상세유형이 기간 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 수정이 가능함 할인 금액(discount_value_unit)이 비율(P)인 경우 할인 반올림 단위(discount_truncation_unit), 할인 단위 처리(discount_truncation_method) 필수 입력 할인 금액(discount_value_unit)이 금액(W)인 경우 discount_purchasing_quantity 필수 입력
product_list 상품 목록 add_category_list 상품 분류 except_category_list 제외 분류 discount_purchasing_quantity 할인 구매수량 T : 구매수량에 따라 F : 구매수량에 관계없이 discount_value 할인 값 discount_value_unit 할인 기준 P : 비율 W : 금액 discount_truncation_unit 할인 반올림 단위 F : 절사안함 C : 0.01 B : 0.1 O : 1 T : 10 M : 100 H : 1000 discount_truncation_method 할인 단위 처리 L : 내림 U : 반올림 C : 올림
gift	사은품 설정 혜택의 상세유형이 사은품 증정인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 수정이 가능함
product_list 상품 목록 add_category_list 상품 분류 offer_only_first 첫 구매 여부 T : 사용함 F : 사용안함 first_purchase_type 첫 구매 기준 O : 주문기준 D : 배송완료 기준 use_unlimited_price 최대가격 제한여부 T : 사용함 F : 사용안함 purchase_start_price 구매가격 제한 (n 이상) purchase_limit_price 구매가격 제한 (n 미만) gift_product_list Array product_no 상품번호 gift_point 차감 점수 max_count 최대 선택 수량
gift_product_bundle	1+N 이벤트 설정 혜택의 상세유형이 1+N 이벤트인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 수정이 가능함
product_list 상품 목록 product_bundle_count 추가 상품 수량
new_product_sale	신규상품할인 설정 혜택의 상세유형이 신규상품 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 수정이 가능함 할인 금액(discount_value_unit)이 비율(P)인 경우 할인 반올림 단위(discount_truncation_unit), 할인 단위 처리(discount_truncation_method) 필수 입력 할인 금액(discount_value_unit)이 금액(W)인 경우 discount_purchasing_quantity 필수 입력
product_list 상품 목록 add_category_list 상품 분류 except_category_list 제외 분류 new_product_date_type 신상품 설정 기준일 I : 상품 등록일 U : 상품 최종 수정일 V : 상품 최종 진열일 new_product_day 신상품 설정 값 new_product_term_type 신상품 설정 단위 D : 일 H : 시간 discount_purchasing_quantity 할인 구매수량 T : 구매수량에 따라 F : 구매수량에 관계없이 discount_value 할인 값 discount_value_unit 할인 기준 P : 비율 W : 금액 discount_truncation_unit 할인 반올림 단위 F : 절사안함 C : 0.01 B : 0.1 O : 1 T : 10 M : 100 H : 1000 discount_truncation_method 할인 단위 처리 L : 내림 U : 반올림 C : 올림
shipping_fee_sale	배송비 할인 설정 혜택의 상세유형이 배송비 할인인 경우 그와 관련한 상세 설정 하위 요소가 입력되어야 정상적인 수정이 가능함
product_list 상품 목록 use_purchase_price_condition 금액 기준 사용여부 T : 사용함 F : 사용안함 total_purchase_price 금액 제한 include_regional_shipping_rate 지역별배송비 포함여부값 T : 포함 F : 미포함
icon_url	아이콘 URL 혜택이 적용되는 상품명에 아이콘이 노출되도록 아이콘 등록 (빈 값으로 요청 시, 기존에 등록된 아이콘 삭제됨)

Request Copy

Response Copy

Delete a customer benefit

DELETE /api/v2/admin/benefits/{benefit_no}

DELETE

생성된 혜택을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	프로모션 쓰기권한 (mall.write_promotion)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호

DEFAULT 1

benefit_no
Required

혜택번호

혜택이 생성된 경우 부여되는 고유 번호

Request Copy

Response Copy

Coupons

쿠폰(Coupons)은 상품의 가격을 할인하거나 배송비를 할인받을 수 있도록 쇼핑몰 회원에게 발급할 수 있는 혜택입니다.
쿠폰은 쇼핑몰의 판매를 촉진하기 위해 사용할 수 있으며, 다양한 형태로 회원에게 발급할 수 있습니다.

Endpoints

GET /api/v2/admin/coupons/count
GET /api/v2/admin/coupons
POST /api/v2/admin/coupons

Coupons properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
coupon_no	쿠폰번호
coupon_type	쿠폰유형 쿠폰유형. 온라인 쿠폰과 오프라인 시리얼 쿠폰 유형이 있음. O : 온라인 쿠폰 S : 오프라인 시리얼 쿠폰
coupon_name	쿠폰명 쿠폰의 이름
coupon_description	쿠폰설명 쿠폰의 설명
created_date	생성일 쿠폰의 생성 일자
deleted	쿠폰삭제 여부 쿠폰이 삭제되었는지 여부. T : 삭제 F : 삭제되지 않음
is_stopped_issued_coupon	쿠폰 완전삭제 (발급된 쿠폰 사용정지) 여부 쿠폰이 완전 삭제되었는지 여부. 쿠폰이 완전 삭제되면 기존에 발급된 쿠폰도 더 이상 사용이 불가함. T : 완전삭제 F : 완전삭제 아님
pause_begin_datetime	쿠폰 발급 일시정지 시작시간 쿠폰 발급을 조건부 자동발급으로 설정한 경우, 조건에 해당해도 발급을 일시정지하는 기간의 시작 시간
pause_end_datetime	쿠폰 발급 일시정지 종료시간 쿠폰 발급을 조건부 자동발급으로 설정한 경우, 조건에 해당해도 발급을 일시정지하는 기간의 종료 시간
benefit_text	쿠폰혜택 상세내역 출력 쿠폰혜택의 상세 내역이 출력됨.
benefit_type	혜택 구분 혜택의 유형. 각각의 유형별로 부여하는 혜택이 다름.
benefit_price	혜택 금액 혜택으로 할인받는 금액
benefit_percentage	혜택 비율 혜택으로 할인받는 비율
benefit_percentage_round_unit	혜택 비율 절사 단위 혜택으로 할인받는 금액의 절사 단위
benefit_percentage_max_price	혜택 비율 최대 금액 혜택으로 할인받을 수 있는 최대 금액
include_regional_shipping_rate	배송비 할인 시 지역별 구분 포함 여부 배송비를 할인할 때 지역별 배송비를 포함할지 여부 T : 지역별 구분 포함 F : 지역별 구분 미포함 DEFAULT F
include_foreign_delivery	해외배송 포함여부 쿠폰혜택에 해외배송을 포함할지 여부 T : 해외배송 포함 F : 해외배송 미포함 DEFAULT F
coupon_direct_url	쿠폰 직접 접근 경로 쿠폰에 직접 접근할 수 있는 경로
issue_type	발급 구분 쿠폰의 발급형태 유형
issue_sub_type	발급 하위 유형 쿠폰 발급의 세부 하위 유형 M : 회원 대상 C : 실시간 접속자 대상 J : 회원 가입 D : 배송 완료 시 A : 기념일(생일) I : 모듈(프로그램) 설치 P : 상품 후기 작성 O : 주문 완료 시 Q : 구매 수량 충족 시 F : 첫 구매 고객 N : 일정기간 미구매 회원 대상 U : 회원등급 상향시
issue_member_join	회원가입시 쿠폰 발급 여부 회원가입 시 발급해주는 쿠폰인지 여부 T : 발급 대상 F : 발급 대상 아님 DEFAULT F
issue_member_join_recommend	회원가입시 추천인에게 쿠폰 발급 여부 회원가입시 추천인에게 발급해주는 쿠폰인지 여부 T : 발급 대상 F : 발급 대상 아님 DEFAULT F
issue_member_join_type	회원가입시 쿠폰 발급 대상 회원가입시 쿠폰을 발급해줄 대상에 대한 구분 A : SMS 수신동의 AND 이메일 수신동의 O : SMS 수신동의 OR 이메일 수신동의 S : SMS 수신동의 E : 이메일 수신동의
issue_order_amount_type	발급가능 구매금액 유형 쿠폰으로 할인 시 할인 대상이 되는 금액의 기준 O : 구매금액 기준 S : 실결제 금액기준
issue_order_start_date	쿠폰발급 가능한 주문시작일시
issue_order_end_date	쿠폰발급 가능한 주문종료일시
issue_order_amount_limit	발급 가능 구매 금액 제한 유형 쿠폰 발급 가능 구매금액을 제한할 수 있음 U : 제한 없음 L : 최소 금액 S : 금액 범위
issue_order_amount_min	발급 가능 최소 구매 금액 쿠폰 발급이 가능한 최소 구매 금액
issue_order_amount_max	발급 가능 최대 구매 금액 쿠폰 발급이 가능한 최대 구매 금액
issue_order_path	주문경로 발급한 쿠폰의 사용 가능한 주문 경로 W : 웹 쇼핑몰 전용 M : 모바일 쇼핑몰 전용 P : 플러스앱 전용
issue_order_type	발급단위 쿠폰 발급 단위 O : 주문서단위 발급쿠폰 P : 상품단위 발급쿠폰
issue_order_available_product	발급 대상 상품 쿠폰 발급 대상이 되는 상품 U : 제한 없음 I : 선택 상품 적용 E : 선택 상품 제외
issue_order_available_category	발급 대상 카테고리 쿠폰 발급 대상이 되는 카테고리 U : 제한 없음 I : 선택 상품 적용 E : 선택 상품 제외
issue_anniversary_type	발급 조건 기념일 유형 쿠폰 발급 조건 기념일의 유형 B : 생일 W : 결혼 기념일
issue_anniversary_pre_issue_day	발급 조건 기념일 선발행 일수 기념일 쿠폰 미리 발급 가능한 일수
issue_module_type	발급 조건 설치 모듈 유형 모듈 설치 발급 쿠폰의 설치 모듈 유형 S : 바로가기 B : 즐겨찾기 L : 라이브링콘
issue_review_count	발급 조건 상품 후기 개수 쿠폰 발급에 필요한 상품 후기의 개수
issue_review_has_image	발급 조건 상품 후기 이미지 포함 여부 쿠폰 발급에 필요한 상품 후기에 이미지가 포함되어야 하는지 여부 T : 포함 F : 미포함 DEFAULT F
issue_quantity_min	쿠폰 발급가능 최소구매수량 쿠폰 발급이 가능한 최소 구매 수량
issue_quntity_type	쿠폰 발급가능수량 판단기준 쿠폰 발급가능수량의 판단이 되는 기준 P : 상품 수량 기준 O : 주문 수량 기준
issue_max_count	최대 발급수 쿠폰의 최대 발급수량
issue_max_count_by_user	동일인 재발급 가능 여부 동일한 고객에게 재발급할 수 있는 최대 쿠폰 수량
issue_count_per_once	쿠폰발급 회당 발급수량 (1회 발급수량) 1회 발급할때의 쿠폰 발급수량
issued_count	발급된 수량 쿠폰이 발급된 수량
issue_member_group_no	발급대상 회원등급 번호 쿠폰발급 대상이 되는 회원등급의 번호
issue_member_group_name	발급대상 회원등급 이름 쿠폰발급 대상이 되는 회원등급의 이름
issue_no_purchase_period	일정기간 미구매 대상 회원의 미구매 기간 일정 기간 미구매 회원 대상 발급시 발급 조건으로 설정한 구매이력이 없는 기간
issue_reserved	자동 발행 예약 사용 여부 쿠폰 발급일자를 미리 예약하는 기능의 사용여부. 해당 예약 일시가 되면 쿠폰은 자동 발행 됨. T : 자동 발행 예약 사용 F : 자동 발행 예약 미사용 DEFAULT F
issue_reserved_date	자동 발행 예약 발급 일시 설정된 쿠폰 자동 발행 예약 일시
available_date	쿠폰 사용기간 쿠폰의 사용 가능한 기간
available_period_type	사용기간 유형 쿠폰의 사용 가능한 기간의 유형
available_begin_datetime	사용 기간 시작 일시 쿠폰 사용 가능 기간 시작일시
available_end_datetime	사용 기간 종료 일시 쿠폰 사용 가능 기간 종료일시
available_site Required	사용 범위 유형 쿠폰 사용 가능한 접속경로의 유형
available_scope	적용 범위 쿠폰 적용 가능한 범위. 상품 쿠폰으로 적용시 상품 하나에 대하여 쿠폰이 적용되며, 주문서 쿠폰으로 적용시 주문서 전체에 적용됨.
available_day_from_issued	사용 가능 일수 쿠폰의 사용 가능 일수
available_price_type	사용가능 구매 금액 유형 쿠폰의 사용가능 금액에 대한 기준. 상품 금액 기준일 경우 상품 가격에 수량을 곱한 금액을 기준으로 하며, 주문 금액 기준일 경우 해당 금액에 기타 할인, 배송비가 적용된 금액을 기준으로 계산한다. U : 제한 없음 O : 주문 금액 기준 P : 상품 금액 기준
available_order_price_type	사용가능 구매 금액 상세 유형 U : 모든 상품의 주문 금액 I : 쿠폰 적용 상품의 주문 금액
available_min_price	사용가능 구매 금액 쿠폰을 사용가능한 구매 금액
available_amount_type	적용 계산 기준 쿠폰을 적용할 기준이 되는 결제 금액. 쿠폰할인을 각종 할인(회원등급할인, 상품할인 등)전 주문금액에 적용할지, 각종 할인 후 금액에 적용할지 여부.
available_payment_method	사용가능 결제수단 쿠폰 사용이 가능한 결제수단 all : 제한없음 R : 무통장입금 E : 가상계좌 C : 신용카드 A : 계좌이체 H : 휴대폰 M : 적립금 K : 케이페이 P : 페이나우 N : 페이코 O : 카카오페이 S : 스마일페이 V : 네이버페이 B : 편의점 D : 토스
available_product	쿠폰적용 상품 선택 쿠폰의 적용가능 상품 선택. 특정 상품을 제외하거나, 적용하거나 혹은 모든 상품에 대해서 쿠폰적용 여부를 선택할 수 있음.
available_product_list	쿠폰적용 상품 리스트
available_category	쿠폰적용 분류 선택 쿠폰의 적용가능 분류 선택. 특정 분류를 제외하거나, 적용하거나 혹은 모든 분류에 대해서 쿠폰적용 여부를 선택할 수 있음.
available_category_list	쿠폰적용 분류 리스트
available_coupon_count_by_order	주문서 당 동일쿠폰 최대 사용 수 한 주문서 당 동일한 쿠폰 최대 사용가능 수
serial_generate_method	시리얼 쿠폰 생성방법 시리얼 쿠폰을 생성하는 방법 A : 자동 생성 M : 직접 등록 E : 엑셀 업로드
coupon_image_type	쿠폰 이미지 유형 쿠폰 이미지의 유형 B : 기본 이미지 사용 C : 직접 업로드
coupon_image_path	쿠폰 이미지 경로 쿠폰 이미지의 URL 경로
show_product_detail	상품상세페이지 노출여부 상품상세페이지에 노출할지 여부 T : 상품상세페이지 노출 F : 상품상세페이지 미노출 DEFAULT F
use_notification_when_login	로그인 시 쿠폰발급 알람 사용여부 회원 로그인 시 쿠폰발급 알람을 사용할지 여부 T : 알람 사용 F : 알람 미사용 DEFAULT F
send_sms_for_issue	쿠폰발급 SMS 발송 여부 쿠폰 발급정보를 SMS로 발송할지 여부 T : SMS 발송 F : SMS 미발송 DEFAULT F
send_email_for_issue	쿠폰 발급정보 이메일 발송여부 쿠폰 발급정보를 이메일로 발송할지 여부 T : 이메일 발송 F : 이메일 미발송 DEFAULT F
discount_amount	할인금액
discount_rate	할인율

Retrieve a count of coupons

GET /api/v2/admin/coupons/count

GET

쇼핑몰에 생성된 쿠폰의 수를 조회합니다.

기본스펙

Property	Description
SCOPE	프로모션 읽기권한 (mall.read_promotion)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
coupon_no	쿠폰번호
coupon_type	쿠폰유형 조회할 쿠폰의 유형 O : 온라인 쿠폰 S : 오프라인 시리얼 쿠폰
coupon_name	쿠폰명
benefit_type	혜택 구분 쿠폰으로 받는 혜택의 종류 구분 ,(콤마)로 여러 건을 검색할 수 있다. A : 할인금액 B : 할인율 C : 적립금액 D : 적립율 E : 기본배송비 할인(전액할인) I : 기본배송비 할인(할인율) H : 기본배송비 할인(할인금액) J : 전체배송비 할인(전액할인) F : 즉시적립 G : 예치금
issue_type	발급 구분 쿠폰의 발급형태 유형 ,(콤마)로 여러 건을 검색할 수 있다. M : 대상자 지정 발급 A : 조건부 자동 발급 D : 고객 다운로드 발급 R : 정기 자동 발급
issue_sub_type	발급 하위 유형 쿠폰 발급의 세부 하위 유형 M : 회원 대상 C : 실시간 접속자 대상 J : 회원 가입 D : 배송 완료 시 A : 기념일(생일) I : 모듈(프로그램) 설치 P : 상품 후기 작성 O : 주문 완료 시 Q : 구매 수량 충족 시 F : 첫 구매 고객 N : 일정기간 미구매 회원 대상 U : 회원등급 상향시
issued_flag	발급된 쿠폰 여부 쿠폰이 기존에 발급된 이력이 있는지 여부 T : 발급이력이 있는 쿠폰 F : 발급이력이 없는 쿠폰
created_start_date 날짜	검색 시작일 쿠폰 생성일 기준 검색의 검색 시작일 검색 종료일과 같이 사용해야함.
created_end_date 날짜	검색 종료일 쿠폰 생성일 기준 검색의 검색 종료일 검색 시작일과 같이 사용해야함.
deleted	쿠폰삭제 여부 쿠폰이 삭제되었는지 여부. ,(콤마)로 여러 건을 검색할 수 있다. T : 삭제된 쿠폰 F : 삭제되지 않은 쿠폰 DEFAULT F
pause_begin_date 날짜	쿠폰 발급 일시정지 시작시간 쿠폰 발급이 일시정지 되기 시작한 시간.
pause_end_date 날짜	쿠폰 발급 일시정지 종료시간 쿠폰 발급의 일시정지가 종료된 시간.
issue_order_path	주문경로 발급한 쿠폰의 사용 가능한 주문 경로 W : PC M : 모바일 P : 플러스앱
issue_order_type	발급단위 P : 상품 쿠폰 O : 주문서 쿠폰
issue_reserved	자동 발행 예약 사용 여부 T : 사용 F : 사용하지 않음
available_period_type	사용기간 유형 쿠폰 사용기간의 유형 ,(콤마)로 여러 건을 검색할 수 있다. F : 일반 기간 R : 쿠폰 발급일 기준 M : 당월 말까지 사용
available_datetime 날짜	해당 날짜에 발급 가능한 쿠폰 검색 해당하는 날짜에 발급 가능한 쿠폰 검색 available_period_type이 F일 때만 유효
available_site	사용 범위 유형 발급한 쿠폰의 사용 가능한 주문 경로 W : 웹 쇼핑몰 전용 M : 모바일 쇼핑몰 전용 P : 플러스앱 전용
available_scope	적용 범위 쿠폰의 적용 가능한 범위가 상품인지 주문서단위 쿠폰인지 여부 P : 상품 쿠폰 O : 주문서 쿠폰
available_price_type	사용가능 구매 금액 유형 쿠폰이 사용 가능한 금액 기준이 주문 금액 기준인지 상품 금액 기준인지 제한이 없는지 여부 U : 제한 없음 O : 주문 금액 기준 P : 상품 금액 기준
available_order_price_type	사용가능 구매 금액 상세 유형 U : 모든 상품의 주문 금액 I : 쿠폰 적용 상품의 주문 금액

Request Copy

Response Copy

Retrieve a list of coupons

GET /api/v2/admin/coupons

GET

쇼핑몰에 생성된 쿠폰을 목록으로 조회합니다.
쿠폰번호, 혜택 구분, 적용 범위등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	프로모션 읽기권한 (mall.read_promotion)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
coupon_no	쿠폰번호
coupon_type	쿠폰유형 O : 온라인 쿠폰 S : 오프라인 시리얼 쿠폰
coupon_name	쿠폰명
benefit_type	혜택 구분 쿠폰으로 받는 혜택의 종류 구분 ,(콤마)로 여러 건을 검색할 수 있다. A : 할인금액 B : 할인율 C : 적립금액 D : 적립율 E : 기본배송비 할인(전액할인) I : 기본배송비 할인(할인율) H : 기본배송비 할인(할인금액) J : 전체배송비 할인(전액할인) F : 즉시적립 G : 예치금
issue_type	발급 구분 쿠폰의 발급형태 유형 ,(콤마)로 여러 건을 검색할 수 있다. M : 대상자 지정 발급 A : 조건부 자동 발급 D : 고객 다운로드 발급 R : 정기 자동 발급
issue_sub_type	발급 하위 유형 쿠폰 발급의 세부 하위 유형 M : 회원 대상 C : 실시간 접속자 대상 J : 회원 가입 D : 배송 완료 시 A : 기념일(생일) I : 모듈(프로그램) 설치 P : 상품 후기 작성 O : 주문 완료 시 Q : 구매 수량 충족 시 F : 첫 구매 고객 N : 일정기간 미구매 회원 대상 U : 회원등급 상향시
issued_flag	발급된 쿠폰 여부 쿠폰이 기존에 발급된 이력이 있는지 여부 T : 발급이력이 있는 쿠폰 F : 발급이력이 없는 쿠폰
created_start_date 날짜	검색 시작일 쿠폰 생성일 기준 검색의 검색 시작일 검색 종료일과 같이 사용해야함.
created_end_date 날짜	검색 종료일 쿠폰 생성일 기준 검색의 검색 종료일 검색 시작일과 같이 사용해야함.
deleted	쿠폰삭제 여부 쿠폰이 삭제되었는지 여부. ,(콤마)로 여러 건을 검색할 수 있다. T : 삭제된 쿠폰 F : 삭제되지 않은 쿠폰 DEFAULT F
pause_begin_date 날짜	쿠폰 발급 일시정지 시작시간 쿠폰 일시정지일 기준 검색의 검색 시작일
pause_end_date 날짜	쿠폰 발급 일시정지 종료시간 쿠폰 일시정지일 기준 검색의 검색 종료일
issue_order_path	주문경로 발급한 쿠폰의 사용 가능한 주문 경로 W : PC M : 모바일 P : 플러스앱
issue_order_type	발급단위 쿠폰의 발급 단위가 상품인지 주문서단위 쿠폰인지 여부 P : 상품 쿠폰 O : 주문서 쿠폰
issue_reserved	자동 발행 예약 사용 여부 쿠폰의 자동발행예약 사용여부 T : 사용 F : 사용하지 않음
available_period_type	사용기간 유형 쿠폰 사용기간의 유형 ,(콤마)로 여러 건을 검색할 수 있다. F : 일반 기간 R : 쿠폰 발급일 기준 M : 당월 말까지 사용
available_datetime 날짜	해당 날짜에 발급 가능한 쿠폰 검색 해당하는 날짜에 발급 가능한 쿠폰 검색 available_period_type이 F일 때만 유효
available_site	사용 범위 유형 발급한 쿠폰의 사용 가능한 주문 경로 W : 웹 쇼핑몰 전용 M : 모바일 쇼핑몰 전용 P : 플러스앱 전용
available_scope	적용 범위 쿠폰의 적용 가능한 범위가 상품인지 주문서단위 쿠폰인지 여부 P : 상품 쿠폰 O : 주문서 쿠폰
available_price_type	사용가능 구매 금액 유형 쿠폰이 사용 가능한 금액 기준이 주문 금액 기준인지 상품 금액 기준인지 제한이 없는지 여부 U : 제한 없음 O : 주문 금액 기준 P : 상품 금액 기준
available_order_price_type	사용가능 구매 금액 상세 유형 U : 모든 상품의 주문 금액 I : 쿠폰 적용 상품의 주문 금액
limit 최소: [1]~최대: [500]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 100
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Create a coupon

POST /api/v2/admin/coupons

POST

쇼핑몰에서 사용할 쿠폰을 발행할 수 있습니다.
쿠폰명, 혜택 구분, 적용 범위등을 지정하여 발행 가능합니다.

기본스펙

Property	Description
SCOPE	프로모션 쓰기권한 (mall.write_promotion)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
coupon_name Required 글자수 최소: [1자]~최대: [50자]	쿠폰명
benefit_type Required	혜택 구분 A : 할인금액 B : 할인율
issue_type Required	발급 구분 M : 대상자 지정 발급
available_period_type Required	사용기간 유형 F : 일반 기간 R : 쿠폰 발급일 기준 M : 당월 말까지 사용
available_begin_datetime 날짜	사용 기간 시작 일시
available_end_datetime 날짜	사용 기간 종료 일시
available_day_from_issued 최소값: [1] 최대값: [999]	사용 가능 일수
available_site Required	사용 범위 유형 W : 웹 쇼핑몰 전용 M : 모바일 쇼핑몰 전용
available_scope Required	적용 범위 P : 상품 쿠폰 O : 주문서 쿠폰
available_product Required	쿠폰적용 상품 선택 U : 제한 없음 I : 선택 상품 적용 E : 선택 상품 제외
available_product_list	쿠폰적용 상품 리스트
available_category Required	쿠폰적용 분류 선택 U : 제한 없음 I : 선택 카테고리 적용 E : 선택 카테고리 제외
available_category_list	쿠폰적용 분류 리스트
available_amount_type Required	적용 계산 기준 E : 할인(쿠폰 제외) 적용 전 결제 금액 I : 할인(쿠폰 제외) 적용 후 결제 금액
available_coupon_count_by_order Required 최소값: [1] 최대값: [999]	주문서 당 동일쿠폰 최대 사용 수
available_price_type	사용가능 구매 금액 유형 U : 제한 없음 O : 주문 금액 기준 P : 상품 금액 기준 DEFAULT U
available_order_price_type	사용가능 구매 금액 상세 유형 U : 모든 상품의 주문 금액 I : 쿠폰 적용 상품의 주문 금액
available_min_price 최소: [0.01]~최대: [999999999]	사용가능 구매 금액
discount_amount	할인금액
benefit_price Required 혜택 금액
discount_rate	할인율
benefit_percentage Required 혜택 비율 benefit_percentage_round_unit Required 혜택 비율 절사 단위 benefit_percentage_max_price Required 혜택 비율 최대 금액

Request Copy

Response Copy

Coupons issues

쿠폰 발급(Coupons issues)은 생성된 쿠폰에 관한 기능입니다.
쿠폰 발급은 하위 리소스로 쿠폰(Coupons) 하위에서만 사용할 수 있습니다.
생성된 쿠폰에 대한 발급, 발급한 쿠폰에 대한 조회가 가능합니다.

Endpoints

GET /api/v2/admin/coupons/{coupon_no}/issues
POST /api/v2/admin/coupons/{coupon_no}/issues

Coupons issues properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
coupon_no	쿠폰번호
issue_no	쿠폰 발급번호
member_id	회원아이디
group_no	발급대상 회원등급 번호
issued_date	쿠폰 발급일자
expiration_date	만료일
used_coupon	쿠폰사용 여부
used_date	쿠폰 사용 일자
related_order_id	관련 주문번호
count	카운트

Retrieve a list of issued coupons

GET /api/v2/admin/coupons/{coupon_no}/issues

GET

생성된 쿠폰에 대한 발급내역의 조회가 가능합니다.
회원아이디, 회원등급번호, 쿠폰사용 여부등을 확인할 수 있습니다.
offset 최대값인 8000개 이상이 발급된 쿠폰의 내역을 조회하기 위해서는 since_issue_no 파라메터를 이용하시면 됩니다.

기본스펙

Property	Description
SCOPE	프로모션 읽기권한 (mall.read_promotion)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
coupon_no Required	쿠폰번호
member_id 최대글자수 : [20자]	회원아이디
group_no	회원등급번호
issued_date 날짜	쿠폰 발급일자
issued_start_date 날짜	검색 시작일
issued_end_date 날짜	검색 종료일
used_coupon	쿠폰사용 여부 T : 사용함 F : 사용안함
since_issue_no	해당 쿠폰 발급번호 이후 검색
limit 최소: [1]~최대: [500]	조회결과 최대건수 DEFAULT 10
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Create coupon issuance history

POST /api/v2/admin/coupons/{coupon_no}/issues

POST

생성된 쿠폰에 대한 발급이 가능합니다.
쿠폰을 발급하기 위해서는 우선 쿠폰을 먼저 생성해야 합니다.

기본스펙

Property	Description
SCOPE	프로모션 쓰기권한 (mall.write_promotion)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
coupon_no Required	쿠폰번호
issued_member_scope Required	회원/조건 선택 쿠폰 발급 대상 회원의 범위를 특정하여 쿠폰을 발급할 수 있음. 특정회원그룹(G)을 입력할 경우 group_no를 필수로 입력해야한다. 특정회원(M)을 입력할 경우 member_id를 필수로 입력해야한다. A : 전체 회원 G : 특정 회원 그룹 M : 특정 회원
group_no	회원등급번호
member_id	회원아이디
send_sms_for_issue	쿠폰발급 SMS 발송 여부 쿠폰 발급정보를 SMS로 발송할지 여부 EC 일본, 베트남, 필리핀 버전에서는 사용할 수 없음. T : 발송함 F : 발송안함 DEFAULT F
allow_duplication	중복발급설정 쿠폰의 중복발급설정 여부. T : 발급함 F : 발급안함 S : 발급안함(사용유무 사용기간 추가검증 안 함) DEFAULT F
single_issue_per_once	1회 발급시 1장만 발급할지 여부 쿠폰을 발급할 때 1회 발급시 1장만 발급할지 여부 T : 1장씩 발급 F : 동시발행수량 설정만큼 발급 DEFAULT T
issue_count_per_once 최소값: [2] 최대값: [10]	다수 발행시 발행 수량 쿠폰 1회 발급시 여러장 발행하는 경우 그 수량 DEFAULT 2
issued_place_type	발급처 구분 쿠폰이 발행된 출처 구분 W : 웹 M : 모바일 P : 플러스앱
issued_by_action_type	앱 설치시 쿠폰 발급 앱 설치시 쿠폰이 발급되는 시점 INSTALLATION : 앱 설치시 쿠폰 발급 ACCEPTING_PUSH : 앱 푸시 수신 On시 쿠폰 발급
issued_by_event_type	발급 사유 구분 혜택으로 인한 쿠폰발급 시 해당되는 혜택 C : 출석체크 이벤트 U : 회원정보 수정 이벤트 B : 배너수익쉐어프로그램 R : 룰렛게임(CMC)팀 Z : 플러스앱설치(플러스앱) Y : 푸시알림 ON(플러스앱) X : 플러스앱 주문(플러스앱) M : 리마인드 Me 주문 W : 리마인드 Me 리워드 V : 통합멤버십 L : 평생회원 전환 이벤트
request_admin_id	발급자 ID

Request Copy

Response Copy

Customers coupons

회원 쿠폰(Customers coupons)은 특정 회원이 보유한 쿠폰에 관한 기능입니다.
회원에게 발급된 쿠폰을 조회하거나 삭제할 수 있습니다.

Endpoints

GET /api/v2/admin/customers/{member_id}/coupons
GET /api/v2/admin/customers/{member_id}/coupons/count
DELETE /api/v2/admin/customers/{member_id}/coupons/{coupon_no}

Customers coupons properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
coupon_no	쿠폰번호
issue_no	쿠폰 발급번호
coupon_name	쿠폰명
available_price_type	사용가능 구매 금액 유형 U : 제한 없음 O : 주문 금액 기준 P : 상품 금액 기준
available_price_type_detail	사용가능 구매 금액 유형 상세 U : 모든 상품의 주문 금액 I : 쿠폰 적용 상품의 주문 금액
available_min_price	사용가능 구매 금액
available_payment_methods	사용가능 결제수단 all : 제한없음 R : 무통장입금 E : 가상계좌 C : 신용카드 A : 계좌이체 H : 휴대폰 M : 적립금 K : 케이페이 P : 페이나우 N : 페이코 O : 카카오페이 S : 스마일페이 V : 네이버페이 B : 편의점 D : 토스
benefit_type	혜택 구분 A : 할인금액 B : 할인율 C : 적립금액 D : 적립율 E : 기본배송비 할인(전액할인) I : 기본배송비 할인(할인율) H : 기본배송비 할인(할인금액) F : 즉시적립 G : 예치금
benefit_price	혜택 금액
benefit_percentage	혜택 비율
benefit_percentage_round_unit	혜택 비율 절사 단위
benefit_percentage_max_price	혜택 비율 최대 금액
credit_amount	예치금 지급 금액
issued_date	발행일
available_begin_datetime	사용 기간 시작 일시
available_end_datetime	사용 기간 종료 일시

Retrieve a list of customer coupons

GET /api/v2/admin/customers/{member_id}/coupons

GET

회원에게 발급된 쿠폰을 목록으로 조회합니다.
쿠폰번호, 혜택 구분, 적용 범위등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	프로모션 읽기권한 (mall.read_promotion)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
member_id Required	회원아이디
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of customer coupons

GET /api/v2/admin/customers/{member_id}/coupons/count

GET

회원에게 발급된 쿠폰의 개수를 조회합니다.

기본스펙

Property	Description
SCOPE	프로모션 읽기권한 (mall.read_promotion)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

member_id
Required

회원아이디

Request Copy

Response Copy

Delete a customer coupon

DELETE /api/v2/admin/customers/{member_id}/coupons/{coupon_no}

DELETE

회원에게 발급된 쿠폰을 삭제합니다.

기본스펙

Property	Description
SCOPE	프로모션 쓰기권한 (mall.write_promotion)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
member_id Required	회원아이디
coupon_no Required	쿠폰번호
issue_no	쿠폰 발급번호

Request Copy

Response Copy

Apps

앱(Apps)는 앱의 정보를 조회하고 수정할 수 있는 리소스입니다.
해당 정보는 앱의 정보이므로, 서로 다른 쇼핑몰에서 호출해도 동일한 정보가 조회되는게 특징입니다.
앱의 버전 정보를 조회하거나 앱의 버전을 API를 통해 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/apps
PUT /api/v2/admin/apps

Apps properties

Attribute	Description
version	버전
version_expiration_date	버전 만료일
initial_version	최초 버전
previous_version	이전 버전
extension_type	확장 타입 section : 섹션(쇼핑몰 프론트에 html 삽입이 필요한 앱 타입) embedded : 임베디드(쇼핑몰 프론트에 임베디드되어 자동으로 구동되는 앱 타입)

Retrieve an app information

GET /api/v2/admin/apps

GET

해당 앱의 버전을 조회할 수 있습니다.
현재 사용 중인 버전의 정보와 버전 만료일, 이전에 사용하던 버전 정보를 확인할 수 있습니다.
해당 정보는 앱의 정보이기 때문에 어떤 쇼핑몰에서 조회해도 동일한 결과가 응답됩니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	40

Request Copy

Response Copy

Update an app information

PUT /api/v2/admin/apps

PUT

해당 앱의 버전을 변경할 수 있습니다.
앱 버전 변경시 최초 버전(initial_version)보다 이전 버전으로 변경은 불가능합니다.
해당 정보는 앱의 정보이기 때문에 어떤 쇼핑몰에서 호출해도 모든 쇼핑몰의 API 버전 정보가 변경됩니다.

기본스펙

Property	Description
SCOPE	앱 쓰기권한 (mall.write_application)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

version

버전

extension_type

확장 타입

section : 섹션(쇼핑몰 프론트에 html 삽입이 필요한 앱 타입)
embedded : 임베디드(쇼핑몰 프론트에 임베디드되어 자동으로 구동되는 앱 타입)

Request Copy

Response Copy

Appstore orders

앱스토어 주문(Appstore orders)은 앱에서 사용 금액이나 기타 금액을 쇼핑몰 운영자에게 부과하기 위한 주문입니다.
앱스토어 주문 생성을 통해 쇼핑몰 운영자에게 결제 필요한 금액을 부과할 수 있으며, 생성된 주문을 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/appstore/orders/{order_id}
POST /api/v2/admin/appstore/orders

Appstore orders properties

Attribute	Description
order_id	주문아이디 앱스토어 주문의 주문 ID
order_name	주문명 앱스토어 주문의 주문 이름. 주문 생성시 지정이 가능하며, 사용자가 결제시 해당 결제의 내용이 무엇인지 알 수 있는 내용이어야 함.
order_amount	주문금액 앱스토어 주문 생성시 결제 요청한 주문 금액
currency	화폐단위 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
return_url	Return Url 사용자가 결제 후 이동해야하는 페이지.
automatic_payment 최대글자수 : [1자]	정기과금 여부 T : 사용함 F : 사용안함
created_date	주문 생성일
confirmation_url	결제 Url 사용자가 결제하기 위해 자동으로 이동하는 페이지 주소

Retreive a Cafe24 Store order

GET /api/v2/admin/appstore/orders/{order_id}

GET

생성된 앱스토어 주문을 조회할 수 있습니다.
주문명, 주문금액, 정기과금 여부 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	10

요청사양

Parameter

Description

order_id

주문번호

조회하고자하는 앱스토어 주문 번호

Request Copy

Response Copy

Create a Cafe24 Store order

POST /api/v2/admin/appstore/orders

POST

앱스토어 주문을 생성할 수 있습니다.
앱스토어 주문을 생성하면 앱 사용자(쇼핑몰 운영자)에게 사용 요금을 부과할 수 있습니다.
또한 정기과금으로 부과할지 선택도 가능합니다.

기본스펙

Property	Description
SCOPE	앱 쓰기권한 (mall.write_application)
호출건수 제한	10
1회당 요청건수 제한	1

요청사양

Parameter	Description
order_name Required 최대글자수 : [100자]	주문명 앱스토어 주문의 주문 이름. 주문 생성시 지정이 가능하며, 사용자가 결제시 해당 결제의 내용이 무엇인지 알 수 있는 내용이어야 함.
order_amount Required	주문금액 사용자에게 결제 받고자 하는 주문 금액 입력
return_url Required 최대글자수 : [250자]	Return Url 사용자가 결제 후 이동해야하는 페이지. 결제 완료 페이지 주소를 입력한다.
automatic_payment 최대글자수 : [1자]	정기과금 여부 T : 사용함 F : 사용안함 DEFAULT F

Request Copy

Response Copy

Appstore payments

앱스토어 주문을 결제 완료한 경우 앱스토어 결제 조회를 통해 결제 내역을 확인할 수 있습니다.

Endpoints

GET /api/v2/admin/appstore/payments
GET /api/v2/admin/appstore/payments/count

Appstore payments properties

Attribute	Description
order_id	결제번호 앱스토어 주문의 주문 ID
payment_status	결제상태 paid : 결제완료 refund : 환불
title	결제 명 앱스토어 주문의 주문 이름. 주문 생성시 지정이 가능하며, 사용자가 결제시 해당 결제의 내용이 무엇인지 알 수 있는 내용이어야 함.
approval_no	승인번호 결제 승인 번호
payment_gateway_name	결제 PG사 이름
payment_method	결제수단
payment_amount	결제금액
refund_amount	환불금액
currency	화폐단위 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
locale_code	결제국가
automatic_payment	정기과금 여부 T : 사용함 F : 사용안함
pay_date	결제승인일
refund_date	환불승인일
expiration_date	만료일

Retrieve a list of Cafe24 Store payments

GET /api/v2/admin/appstore/payments

GET

쇼핑몰 운영자가 결제한 앱스토어 이용 결제 내역의 카운트를 확인할 수 있습니다.
결제상태, 결제명, 승인번호 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	10

요청사양

Parameter	Description
order_id	주문번호 조회하고자하는 앱스토어 주문 번호 ,(콤마)로 여러 건을 검색할 수 있다.
start_date Required 날짜	검색 시작일 해당일 이후에 결제완료된 주문 검색
end_date Required 날짜	검색 종료일 해당일 이전에 결제완료된 주문 검색
currency	화폐단위 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
limit 최소: [1]~최대: [50]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 20
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Retrieve a count of Cafe24 Store payments

GET /api/v2/admin/appstore/payments/count

GET

쇼핑몰 운영자가 결제한 앱스토어 이용 결제 내역을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	10

요청사양

Parameter	Description
order_id	주문번호 조회하고자하는 앱스토어 주문 번호 ,(콤마)로 여러 건을 검색할 수 있다.
start_date Required 날짜	검색 시작일 해당일 이후에 결제완료된 주문 검색
end_date Required 날짜	검색 종료일 해당일 이전에 결제완료된 주문 검색
currency	화폐단위 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소

Request Copy

Response Copy

Recipes

레시피(Recipes)와 관련된 기능으로,
쇼핑몰에 레시피를 등록하거나, 등록된 레시피를 목록으로 조회하거나, 등록된 레시피를 삭제할 수 있습니다.

Endpoints

GET /api/v2/admin/recipes
POST /api/v2/admin/recipes
DELETE /api/v2/admin/recipes/{recipe_code}

Recipes properties

Attribute

Description

recipe_code

레시피 코드

recipe_name

최대글자수 : [200자]

레시피 이름

active

활성화 여부

T : 활성화
F : 비활성화

Retrieve a list of recipes

GET /api/v2/admin/recipes

GET

쇼핑몰에 등록된 레시피를 목록으로 조회할 수 있습니다.
레시피 코드, 이름, 활성화 여부를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	40

Request Copy

Response Copy

Create a recipe

POST /api/v2/admin/recipes

POST

쇼핑몰에 레시피를 등록할 수 있습니다.
레시피 등록을 위해서는 레시피가 이미 생성되어있어야 하며 해당 생성된 레시피 코드가 필요합니다.

기본스펙

Property	Description
SCOPE	앱 쓰기권한 (mall.write_application)
호출건수 제한	40
1회당 요청건수 제한	100

요청사양

Parameter	Description
recipe_code Required	레시피 코드
trigger_settings	트리거 설정
required_filters Array name 조건 이름 value 조건 값 operator 조건 연산자 optional_filters Array condition Array name 조건 이름 value 조건 값 operator 조건 연산자

Request Copy

Response Copy

Delete a recipe

DELETE /api/v2/admin/recipes/{recipe_code}

DELETE

쇼핑몰에 등록된 레시피를 등록해제할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 쓰기권한 (mall.write_application)
호출건수 제한	40

요청사양

Parameter	Description
recipe_code Required	레시피 코드

Request Copy

Response Copy

Scripttags

스크립트태그(Scripttags)는 앱에서 쇼핑몰의 특정 화면(Page)에 스크립트를 설치하기 위해 사용할 수 있는 기능입니다.
스크립트 API를 사용해 쇼핑몰의 디자인을 변경하지 않고 쇼핑몰 화면에 스크립트를 쉽게 추가할 수 있습니다.

Endpoints

GET /api/v2/admin/scripttags
GET /api/v2/admin/scripttags/count
GET /api/v2/admin/scripttags/{script_no}
POST /api/v2/admin/scripttags
PUT /api/v2/admin/scripttags/{script_no}
DELETE /api/v2/admin/scripttags/{script_no}

Scripttags properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
script_no	script의 고유번호 스크립트의 고유 번호
client_id	Client ID 스크립트를 설치한 Client의 ID
src URL	원본 script 경로 설치할 스크립트의 원본 경로(절대 경로)
display_location	화면 경로 스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함. (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨) 화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 [쇼핑몰 설정 > 사이트 설정 > '사이트 환경 설정 > 쇼핑몰 환경 설정 > 화면경로 > 화면경로 설정']에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음. "all" 일 경우 전체 페이지에 스크립트가 적용됨. display_location_code
exclude_path	제외 경로
skin_no	스킨 번호 스크립트를 적용할 스킨 번호
integrity	하위 리소스 무결성 스크립트 위변조를 방지하기위한 무결성 검증용 해시. (sha384, sha512 해시 알고리즘 지원) Integrity 해시 생성방법 참고
created_date	생성일 스크립트 설치 날짜
updated_date	수정일 스크립트 수정 날짜

Retrieve a list of script tags

GET /api/v2/admin/scripttags

GET

쇼핑몰에 설치된 스크립트를 목록으로 조회할 수 있습니다.
스크립트 고유번호, 화면경로, 생성일 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
script_no	script의 고유번호 스크립트의 고유 번호 검색
src URL	원본 script 경로 원본 스크립트 경로 검색
display_location	화면 경로 스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함. (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨) 화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 [쇼핑몰 설정 > 사이트 설정 > '사이트 환경 설정 > 쇼핑몰 환경 설정 > 화면경로 > 화면경로 설정']에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음. "all" 일 경우 전체 페이지에 스크립트가 적용됨. display_location_code ,(콤마)로 여러 건을 검색할 수 있다.
exclude_path	제외 경로 ,(콤마)로 여러 건을 검색할 수 있다.
skin_no	스킨 번호 스크립트를 적용할 스킨 번호 ,(콤마)로 여러 건을 검색할 수 있다.
integrity	하위 리소스 무결성
created_start_date 날짜	스크립트 설치일 검색 시작일 스크립트 설치 날짜가 해당 날짜 이후인 스크립트 검색 검색 종료일과 같이 사용해야함.
created_end_date 날짜	스크립트 설치일 검색 종료일 스크립트 설치 날짜가 해당 날짜 이전인 스크립트 검색 검색 시작일과 같이 사용해야함.
updated_start_date 날짜	스크립트 수정일 검색 시작일 스크립트 수정 날짜가 해당 날짜 이후인 스크립트 검색 검색 종료일과 같이 사용해야함.
updated_end_date 날짜	스크립트 수정일 검색 종료일 스크립트 수정 날짜가 해당 날짜 이전인 스크립트 검색 검색 시작일과 같이 사용해야함.

Request Copy

Response Copy

Retrieve a count of script tags

GET /api/v2/admin/scripttags/count

GET

쇼핑몰에 설치된 스크립트의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
script_no	script의 고유번호 스크립트의 고유 번호 검색
src URL	원본 script 경로 원본 스크립트 경로 검색
display_location	화면 경로 스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함. (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨) 화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 [쇼핑몰 설정 > 사이트 설정 > '사이트 환경 설정 > 쇼핑몰 환경 설정 > 화면경로 > 화면경로 설정']에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음. "all" 일 경우 전체 페이지에 스크립트가 적용됨. display_location_code
skin_no	스킨 번호 스크립트를 적용할 스킨 번호. ,(콤마)로 여러 건을 검색할 수 있다.
created_start_date 날짜	스크립트 설치일 검색 시작일 스크립트 설치 날짜가 해당 날짜 이후인 스크립트 검색 검색 종료일과 같이 사용해야함.
created_end_date 날짜	스크립트 설치일 검색 종료일 스크립트 설치 날짜가 해당 날짜 이전인 스크립트 검색 검색 종료일과 같이 사용해야함.
updated_start_date 날짜	스크립트 수정일 검색 시작일 스크립트 수정 날짜가 해당 날짜 이후인 스크립트 검색 검색 종료일과 같이 사용해야함.
updated_end_date 날짜	스크립트 수정일 검색 종료일 스크립트 수정 날짜가 해당 날짜 이전인 스크립트 검색 검색 시작일과 같이 사용해야함.

Request Copy

Response Copy

Retrieve a script tag

GET /api/v2/admin/scripttags/{script_no}

GET

쇼핑몰에 설치된 특정 스크립트를 조회할 수 있습니다.
화면경로, 스킨번호, 생성일, 수정일 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	10

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

script_no

script의 고유번호

스크립트의 고유 번호 검색

Request Copy

Response Copy

Create a script tag

POST /api/v2/admin/scripttags

POST

스크립트태그를 쇼핑몰의 특정 화면에 설치할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 쓰기권한 (mall.write_application)
호출건수 제한	10
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
src URL	원본 script 경로 설치할 스크립트의 원본 경로(절대 경로)
display_location Required	화면 경로 스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함. (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨) 화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 [쇼핑몰 설정 > 사이트 설정 > '사이트 환경 설정 > 쇼핑몰 환경 설정 > 화면경로 > 화면경로 설정']에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음. "all" 일 경우 전체 페이지에 스크립트가 적용됨. display_location_code
exclude_path	제외 경로
skin_no	스킨 번호 스크립트를 적용할 스킨 번호.
integrity	하위 리소스 무결성 스크립트 위변조를 방지하기위한 무결성 검증용 해시. (sha384, sha512 해시 알고리즘 지원) Integrity 해시 생성방법 참고

Request Copy

Response Copy

Update a script tag

PUT /api/v2/admin/scripttags/{script_no}

PUT

쇼핑몰에 설치된 스크립트를 업데이트할 수 있습니다.
앱을 재설치할 필요 없이 스크립트만 업데이트 할 수 있습니다.

기본스펙

Property	Description
SCOPE	앱 쓰기권한 (mall.write_application)
호출건수 제한	10
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
script_no Required	script의 고유번호 스크립트의 고유 번호
src URL	원본 script 경로 설치할 스크립트의 원본 경로(절대 경로)
display_location	화면 경로 스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함. (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨) 화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 [쇼핑몰 설정 > 사이트 설정 > '사이트 환경 설정 > 쇼핑몰 환경 설정 > 화면경로 > 화면경로 설정']에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음. "all" 일 경우 전체 페이지에 스크립트가 적용됨. display_location_code
exclude_path	제외 경로
skin_no	스킨 번호 스크립트를 적용할 스킨 번호.
integrity	하위 리소스 무결성 스크립트 위변조를 방지하기위한 무결성 검증용 해시. (sha384, sha512 해시 알고리즘 지원) Integrity 해시 생성방법 참고

Request Copy

Response Copy

Delete a script tag

DELETE /api/v2/admin/scripttags/{script_no}

DELETE

쇼핑몰에 설치되어 있는 스크립트를 삭제할 수 있습니다.
멀티쇼핑몰별로 삭제하려면 엔드포인트 뒤에 "?shop_no=N"을 추가하면 됩니다.

기본스펙

Property	Description
SCOPE	앱 쓰기권한 (mall.write_application)
호출건수 제한	10

요청사양

Parameter

Description

script_no
Required

script의 고유번호

스크립트의 고유 번호

Request Copy

Response Copy

Webhooks logs

웹훅 로그(Webhooks logs)를 통해 앱에서 발생한 웹훅의 로그를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/webhooks/logs

Webhooks logs properties

Attribute	Description
log_id	로그 ID
log_type	로그 종류 G : 일반 발송 R : 재발송 T : 테스트 발송
event_no	이벤트 번호
mall_id	쇼핑몰 ID
trace_id	Trace ID
requested_time	전송일시
request_endpoint	요청 URL
request_body	요청 내용
success	웹훅 발송 성공 여부 T : 성공 F : 실패
response_http_code	응답 http code
response_body	응답 내용

Retrieve a list of webhook logs

GET /api/v2/admin/webhooks/logs

GET

앱에서 발생한 웹훅 로그의 목록을 조회합니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	40

요청사양

Parameter	Description
requested_start_date 날짜	발송 시작일시
requested_end_date 날짜	발송 종료일시
success	웹훅 발송 성공 여부 T : 성공 F : 실패
log_type	로그 종류 G : 일반 발송 R : 재발송 T : 테스트 발송
since_log_id	해당 로그 ID 이후 검색
limit 최소: [1]~최대: [10000]	조회결과 최대건수

Request Copy

Response Copy

Webhooks setting

쇼핑몰이 웹훅 사용에 동의(실시간 정보 조회 권한 동의)에 대해 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/webhooks/setting

Webhooks setting properties

Attribute	Description
scopes	실시간 정보제공 권한

Retrieve webhook settings

GET /api/v2/admin/webhooks/setting

GET

쇼핑몰이 웹훅 사용에 동의(실시간 정보 조회 권한 동의)에 대해 조회합니다.

기본스펙

Property	Description
SCOPE	앱 읽기권한 (mall.read_application)
호출건수 제한	40

Request Copy

Response Copy

Autodisplay

자동 진열(Autodisplay)은 상품 분류에 특정 조건에 따라 상품을 자동으로 진열해주는 기능입니다.
예를 들어 가장 판매량이 높은 순서대로 상품을 진열하거나 좋아요 수가 높은 수 등으로 진열되도록 설정할 수 있습니다.
해당 리소스에서는 자동 진열 조건을 생성하거나, 수정, 삭제하고 자동 진열 조건을 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/autodisplay
POST /api/v2/admin/autodisplay
PUT /api/v2/admin/autodisplay/{display_no}
DELETE /api/v2/admin/autodisplay/{display_no}

Autodisplay properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
display_no	자동진열 번호
use_main	메인분류 여부 T: 메인분류 F: 상품분류
category_no	분류 번호
display_group	상세 상품분류
display_count 최소: [1]~최대: [200]	자동진열 최대 상품 수
use_reservation	예약진열 사용여부 T: 사용함 F: 사용안함
start_date	예약 시작일
use_hashtag	해시태그 사용여부 T: 사용함 F: 사용안함
hash_tags	해시태그
display_sort	정렬순서 AOD: 주문 수 높은 순서대로 AOA: 주문 수 낮은 순서대로 AVD: 조회 수 높은 순서대로 AVA: 조회 수 낮은 순서대로 ARD: 주문율 높은 순서대로 ARA: 주문율 낮은 순서대로 ACD: 클릭 가치 높은 순서대로 AND: 신규 등록된 순서대로 APD: 판매가 높은 순서대로 APA: 판매가 낮은 순서대로 RD : 최근 등록상품이 위로 RA : 최근 등록상품이 아래로 UD : 최근 수정상품이 위로 UA : 최근 수정상품이 아래로 NA : 상품명 가나다순 ND : 상품명 가나다역순 PD : 판매가 높은 상품이 위로 PA : 판매가 높은 상품이 아래로 SD : 판매량 높은 상품이 위로 SA : 판매량 높은 상품이 아래로 CD : 조회수가 높은 상품이 위로 CA : 조회수가 높은 상품이 아래로 LD : 좋아요수가 높은 상품이 위로 LA : 좋아요수가 높은 상품이 아래로
timetable 배열 최대사이즈: [24]	업데이트 시간
period	데이터 집계 기간 1: 1일 3: 3일 7: 1주(7일) 30: 30일
except_categories_scope	제외 분류 설정 A: 모든 분류에 적용 C : 이 분류만 적용
except_categories	제외 분류

Retrieve a list of auto layouts

GET /api/v2/admin/autodisplay

GET

생성된 모든 자동 진열을 목록을 통해 조회할 수 있습니다.
자동진열 번호, 예약진열 사용여부, 자동진열 최대 상품 수 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_no

자동진열 번호

Request Copy

Response Copy

Create auto layout for selected product category

POST /api/v2/admin/autodisplay

POST

특정 조건에 따라 자동 진열을 생성합니다.

기본스펙

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
use_main Required	메인분류 여부 T: 메인분류 F: 상품분류
category_no Required	분류 번호
display_group Required	상세 상품분류
display_count Required 최소: [1]~최대: [200]	자동진열 최대 상품 수
use_reservation Required	예약진열 사용여부 T: 사용함 F: 사용안함
start_date	예약 시작일
use_hashtag Required	해시태그 사용여부 T: 사용함 F: 사용안함
hash_tags	해시태그
display_sort	정렬순서 정렬 조건(RD, RA, UD, UA, NA, ND, PD, PA, SD, SA, AD, AA, LD, LA)은 use_hashtag가 "T"일 경우에만 사용 가능 AOD: 주문 수 높은 순서대로 AOA: 주문 수 낮은 순서대로 AVD: 조회 수 높은 순서대로 AVA: 조회 수 낮은 순서대로 ARD: 주문율 높은 순서대로 ARA: 주문율 낮은 순서대로 ACD: 클릭 가치 높은 순서대로 AND: 신규 등록된 순서대로 APD: 판매가 높은 순서대로 APA: 판매가 낮은 순서대로 RD : 최근 등록상품이 위로 RA : 최근 등록상품이 아래로 UD : 최근 수정상품이 위로 UA : 최근 수정상품이 아래로 NA : 상품명 가나다순 ND : 상품명 가나다역순 PD : 판매가 높은 상품이 위로 PA : 판매가 높은 상품이 아래로 SD : 판매량 높은 상품이 위로 SA : 판매량 높은 상품이 아래로 CD : 조회수가 높은 상품이 위로 CA : 조회수가 높은 상품이 아래로 LD : 좋아요수가 높은 상품이 위로 LA : 좋아요수가 높은 상품이 아래로
timetable 배열 최대사이즈: [24]	업데이트 시간
period	데이터 집계 기간 1: 1일 3: 3일 7: 1주(7일) 30: 30일
except_categories_scope	제외 분류 설정 A: 모든 분류에 적용 C : 이 분류만 적용 DEFAULT A
except_categories	제외 분류

Request Copy

Response Copy

Update auto layout for selected product category

PUT /api/v2/admin/autodisplay/{display_no}

PUT

기존 자동 진열을 수정합니다.
자동진열 최대 상품 수, 예약진열 사용여부 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
display_no Required	자동진열 번호
display_count 최소: [1]~최대: [200]	자동진열 최대 상품 수
use_reservation	예약진열 사용여부 T: 사용함 F: 사용안함
start_date	예약 시작일
use_hashtag	해시태그 사용여부 T: 사용함 F: 사용안함
hash_tags	해시태그
display_sort	정렬순서 정렬 조건(RD, RA, UD, UA, NA, ND, PD, PA, SD, SA, AD, AA, LD, LA)은 use_hashtag가 "T"일 경우에만 사용 가능 AOD: 주문 수 높은 순서대로 AOA: 주문 수 낮은 순서대로 AVD: 조회 수 높은 순서대로 AVA: 조회 수 낮은 순서대로 ARD: 주문율 높은 순서대로 ARA: 주문율 낮은 순서대로 ACD: 클릭 가치 높은 순서대로 AND: 신규 등록된 순서대로 APD: 판매가 높은 순서대로 APA: 판매가 낮은 순서대로 RD : 최근 등록상품이 위로 RA : 최근 등록상품이 아래로 UD : 최근 수정상품이 위로 UA : 최근 수정상품이 아래로 NA : 상품명 가나다순 ND : 상품명 가나다역순 PD : 판매가 높은 상품이 위로 PA : 판매가 높은 상품이 아래로 SD : 판매량 높은 상품이 위로 SA : 판매량 높은 상품이 아래로 CD : 조회수가 높은 상품이 위로 CA : 조회수가 높은 상품이 아래로 LD : 좋아요수가 높은 상품이 위로 LA : 좋아요수가 높은 상품이 아래로
timetable 배열 최대사이즈: [24]	업데이트 시간
period	데이터 집계 기간 1: 1일 3: 3일 7: 1주(7일) 30: 30일
except_categories_scope	제외 분류 설정 A: 모든 분류에 적용 C : 이 분류만 적용
except_categories	제외 분류

Request Copy

Response Copy

Delete auto layout for selected product category

DELETE /api/v2/admin/autodisplay/{display_no}

DELETE

생성된 자동 진열을 삭제합니다.

기본스펙

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

display_no
Required

자동진열 번호

Request Copy

Response Copy

Categories decorationimages

카테고리 꾸미기 이미지(Categories decorationimages)는 특정 카테고리의 꾸미기 이미지에 관한 기능입니다.
특정 카테고리에 설정된 꾸미기 이미지를 조회하거나 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/categories/{category_no}/decorationimages
PUT /api/v2/admin/categories/{category_no}/decorationimages

Categories decorationimages properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
category_no	분류 번호
use_menu_image_pc	분류 PC 메뉴 이미지 사용여부 T : 사용함 F : 사용안함
menu_image_pc	분류 PC 메뉴 기본 이미지
menu_over_image_pc	분류 PC 메뉴 오버 이미지
use_top_image_pc	분류 PC 상단 이미지 사용여부 T : 사용함 F : 사용안함
top_images_pc	분류 PC 상단 이미지
use_title_image_pc	분류 PC 타이틀 이미지 사용여부 T : 사용함 F : 사용안함
title_image_pc	분류 PC 타이틀 이미지
use_menu_image_mobile	분류 모바일 메뉴 이미지 사용여부 T : 사용함 F : 사용안함
menu_image_mobile	분류 모바일 메뉴 기본 이미지
use_top_image_mobile	분류 모바일 상단 이미지 사용여부 T : 사용함 F : 사용안함
top_images_mobile 배열 최대사이즈: [3]	분류 모바일 상단 이미지
use_title_image_mobile	분류 모바일 타이틀 이미지 사용여부 T : 사용함 F : 사용안함
title_image_mobile	분류 모바일 타이틀 이미지

Retrieve decoration image settings by category

GET /api/v2/admin/categories/{category_no}/decorationimages

GET

분류번호를 이용하여 해당 분류의 꾸미기 정보를 조회합니다.

기본스펙

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

category_no
Required

분류 번호

Request Copy

Response Copy

Update decoration images of a product category

PUT /api/v2/admin/categories/{category_no}/decorationimages

PUT

분류번호를 이용하여 해당 분류의 꾸미기 정보를 수정합니다.
분류 PC 메뉴 이미지 사용여부, 기본이미지 등을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
category_no Required	분류 번호
use_menu_image_pc	분류 PC 메뉴 이미지 사용여부 T : 사용함 F : 사용안함
menu_image_pc	분류 PC 메뉴 기본 이미지
menu_over_image_pc	분류 PC 메뉴 오버 이미지
use_top_image_pc	분류 PC 상단 이미지 사용여부 T : 사용함 F : 사용안함
top_images_pc 배열 최대사이즈: [3]	분류 PC 상단 이미지
use_title_image_pc	분류 PC 타이틀 이미지 사용여부 T : 사용함 F : 사용안함
title_image_pc	분류 PC 타이틀 이미지
use_menu_image_mobile	분류 모바일 메뉴 이미지 사용여부 T : 사용함 F : 사용안함
menu_image_mobile	분류 모바일 메뉴 기본 이미지
use_top_image_mobile	분류 모바일 상단 이미지 사용여부 T : 사용함 F : 사용안함
top_images_mobile 배열 최대사이즈: [3]	분류 모바일 상단 이미지
use_title_image_mobile	분류 모바일 타이틀 이미지 사용여부 T : 사용함 F : 사용안함
title_image_mobile	분류 모바일 타이틀 이미지

Request Copy

Response Copy

Categories seo

카테고리 SEO(Categories seo)는 특정 카테고리의 SEO 에 대한 설정과 설정값의 조회가 가능한 기능입니다.
SEO는 검색엔진 최적화(Search Engine Optimization)의 약자로서 본 기능을 활용하여 검색엔진에 카테고리나 쇼핑몰이 더 잘 검색될 수 있도록 할 수 있습니다.
카테고리 SEO는 카테고리의의 하위 리소스로서 특정 카테고리의 검색엔진 최적화 설정을 할 수 있습니다.

Endpoints

GET /api/v2/admin/categories/{category_no}/seo
PUT /api/v2/admin/categories/{category_no}/seo

Categories seo properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
category_no	분류 번호
search_engine_exposure	검색 엔진 노출 설정 T : 사용함 F : 사용안함
meta_title	브라우저 타이틀
meta_author	메타태그1 : Author
meta_description	메타태그2 : Description
meta_keywords	메타태그3 : Keywords

Retrieve SEO settings by category

GET /api/v2/admin/categories/{category_no}/seo

GET

특정 카테고리의 SEO 설정을 조회할 수 있습니다.
검색 엔진 노출 설정, 브라우저 타이틀 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

category_no
Required

분류 번호

Request Copy

Response Copy

Update a product category SEO

PUT /api/v2/admin/categories/{category_no}/seo

PUT

특정 카테고리의 SEO 설정을 수정할 수 있습니다.
검색 엔진 노출 설정, 브라우저 타이틀 등을 설정할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품분류 쓰기권한 (mall.write_category)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shop_no	멀티쇼핑몰 번호 DEFAULT 1
category_no Required	분류 번호
search_engine_exposure	검색 엔진 노출 설정 T : 사용함 F : 사용안함
meta_title	브라우저 타이틀
meta_author	메타태그1 : Author
meta_description	메타태그2 : Description
meta_keywords	메타태그3 : Keywords

Request Copy

Response Copy

Mains

메인분류(Mains)는 쇼핑몰의 상품을 메인화면에 진열할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/mains

Mains properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
module_code	모듈 코드 각 메인분류에 지정된 모듈 코드
display_group	메인분류 번호
group_name	메인분류 명 메인분류 생성 당시 지정한 분류명
soldout_sort_type	품절상품진열 품절상품을 진열할 위치 B : 품절상품 맨 뒤로 N : 품절상품 상관없음

Retrieve a list of main categories

GET /api/v2/admin/mains

GET

쇼핑몰에 진열된 메인분류들의 정보를 조회할 수 있습니다.
메인분류 번호, 메인분류 명, 품절상품진열 설정을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	상품분류 읽기권한 (mall.read_category)
호출건수 제한	40

Request Copy

Response Copy

Brands

브랜드(Brands)는 쇼핑몰 상품의 "브랜드"를 나타냅니다.
브랜드는 쇼핑몰의 상품을 구분하는 판매분류의 하나로, 상품은 반드시 하나의 브랜드를 갖고 있습니다.
브랜드가 미지정된 경우 "자체브랜드"를 사용합니다.

Endpoints

GET /api/v2/admin/brands
GET /api/v2/admin/brands/count
POST /api/v2/admin/brands
PUT /api/v2/admin/brands/{brand_code}
DELETE /api/v2/admin/brands/{brand_code}

Brands properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
brand_code	브랜드 코드
brand_name 최대글자수 : [50자]	브랜드 명
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함
search_keyword 최대글자수 : [200자]	검색어 설정
product_count	상품수
created_date	생성일

Retrieve a list of brands

GET /api/v2/admin/brands

GET

현재 쇼핑몰에 있는 브랜드를 조회할 수 있습니다.
브랜드명, 브랜드 사용여부, 상품수 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
brand_code	브랜드 코드 ,(콤마)로 여러 건을 검색할 수 있다.
brand_name	브랜드 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Request Copy

Response Copy

Retrieve a count of brands

GET /api/v2/admin/brands/count

GET

현재 쇼핑몰에 있는 브랜드의 숫자를 카운트합니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
brand_code	브랜드 코드 ,(콤마)로 여러 건을 검색할 수 있다.
brand_name	브랜드 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함

Request Copy

Response Copy

Create a brand

POST /api/v2/admin/brands

POST

브랜드를 생성합니다.
브랜드 명과 브랜드 사용 여부 등을 설정할 수 있으며, 상품 검색시 해당 브랜드 상품이 검색될 수 있도록 검색어를 지정할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
brand_name Required	브랜드 명
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함 DEFAULT T
search_keyword 최대글자수 : [200자]	검색어 설정

Request Copy

Response Copy

Update a brand

PUT /api/v2/admin/brands/{brand_code}

PUT

특정 브랜드의 정보를 수정할 수 있습니다.
브랜드명, 브랜드 사용여부 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shop_no	멀티쇼핑몰 번호 DEFAULT 1
brand_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드
brand_name	브랜드 명
use_brand	브랜드 사용여부 T : 사용함 F : 사용안함 DEFAULT T
search_keyword 최대글자수 : [200자]	검색어 설정

Request Copy

Response Copy

Delete a brand

DELETE /api/v2/admin/brands/{brand_code}

DELETE

특정 브랜드를 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40

요청사양

Parameter	Description
brand_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	브랜드 코드

Request Copy

Response Copy

Classifications

자체분류(Classifications)는 상품등록시 사용할 자체분류에 입력하는 정보를 의미합니다.
자체분류는 상품을 구분하는 판매분류의 하나이며, 상품은 반드시 하나의 자체분류를 가지고 있습니다.

Endpoints

GET /api/v2/admin/classifications
GET /api/v2/admin/classifications/count

Classifications properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
classification_code 형식 : [A-Z0-9] 최소글자수 : [8자] 최대글자수 : [8자]	자체분류 코드
classification_name 최대글자수 : [200자]	자체분류 명
classification_description 최대글자수 : [300자]	자체분류 설명
use_classification	사용여부
created_date	생성일
product_count	상품수

Retrieve a list of custom categories

GET /api/v2/admin/classifications

GET

쇼핑몰에 등록된 자체분류를 목록으로 조회합니다.
자체분류의 분류코드와 분류명 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
classification_code	자체분류 코드 ,(콤마)로 여러 건을 검색할 수 있다.
classification_name	자체분류 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_classification	사용여부
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Request Copy

Response Copy

Retrieve a count of custom categories

GET /api/v2/admin/classifications/count

GET

쇼핑몰에 등록된 자체분류의 수를 조회합니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
classification_code	자체분류 코드 ,(콤마)로 여러 건을 검색할 수 있다.
classification_name	자체분류 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_classification	사용여부

Request Copy

Response Copy

Manufacturers

제조사(Manufacturers)는 상품의 제작정보 중 제조사에 입력하는 정보입니다.
제조사는 상품을 제작, 생산한 주체를 나타내며, 상품을 구분하는 판매분류 중 하나입니다.
상품은 반드시 하나의 제조사를 갖고 있습니다.(미지정시 '자체제작'을 사용함)
제조사의 목록조회, 수 조회, 상세조회, 생성, 수정이 가능합니다.

Endpoints

GET /api/v2/admin/manufacturers
GET /api/v2/admin/manufacturers/{manufacturer_code}
GET /api/v2/admin/manufacturers/count
POST /api/v2/admin/manufacturers
PUT /api/v2/admin/manufacturers/{manufacturer_code}

Manufacturers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
manufacturer_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드 시스템이 부여한 제조사의 코드. 해당 쇼핑몰 내에서 제조사 코드는 중복되지 않는다.
manufacturer_name 최대글자수 : [50자]	제조사명 제조사의 이름. 제조사명은 쇼핑몰 관리자 화면에서 제조사를 구분할 수 있는 기본적인 정보이다.
president_name 최대글자수 : [30자]	대표자명 제조사의 대표자 이름.
use_manufacturer	사용여부 해당 제조사를 사용하는지 여부 표시 T : 사용함 F : 사용안함
email 최대글자수 : [255자]	이메일 제조사의 문의 메일.
phone 최대글자수 : [20자]	전화번호 제조사의 전화번호.
homepage 최대글자수 : [255자]	홈페이지 제조사의 홈페이지 주소
zipcode	우편번호 제조사의 사업장 우편번호.
country_code	국가코드
address1 최대글자수 : [255자]	기본 주소 제조사의 사업장 주소(시/군/구 단위 표기)
address2 최대글자수 : [255자]	상세 주소 제조사의 사업장 주소(상세 주소 표기)
created_date	생성일

Retrieve a list of manufacturers

GET /api/v2/admin/manufacturers

GET

쇼핑몰에 등록된 제조사들의 정보를 목록으로 조회합니다.
제조사명, 대표자명, 전화번호 등을 조회할 수 있습니다.
목록조회의 응답값은 상세조회보다 간소합니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
manufacturer_code	제조사 코드 조회하고자 하는 제조사의 코드. ,(콤마)로 여러 건을 검색할 수 있다.
manufacturer_name	제조사명 ,(콤마)로 여러 건을 검색할 수 있다.
use_manufacturer	제조사 사용여부 T : 사용함 F : 사용안함
offset 최대값: [8000]	조회결과 시작위치 조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Request Copy

Response Copy

Retrieve a manufacturer

GET /api/v2/admin/manufacturers/{manufacturer_code}

GET

쇼핑몰에 등록된 제조사의 상세정보를 조회합니다.
제조사명, 대표자명, 제조사 사용여부 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

manufacturer_code
Required

형식 : [A-Z0-9]
글자수 최소: [8자]~최대: [8자]

제조사 코드

Request Copy

Response Copy

Retrieve a count of manufacturers

GET /api/v2/admin/manufacturers/count

GET

쇼핑몰에 등록된 제조사의 수를 조회합니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
manufacturer_code	제조사 코드 조회하고자 하는 제조사의 코드. ,(콤마)로 여러 건을 검색할 수 있다.
manufacturer_name	제조사명 검색어를 제조사명에 포함하고 있는 공급사 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다.
use_manufacturer	제조사 사용여부 T : 사용함 F : 사용안함

Request Copy

Response Copy

Create a manufacturer

POST /api/v2/admin/manufacturers

POST

쇼핑몰에 제조사를 새로 등록합니다.

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
manufacturer_name Required	제조사명
president_name Required 최대글자수 : [30자]	대표자명
email 최대글자수 : [255자] 이메일	이메일
phone 최대글자수 : [20자] 전화번호	전화번호
homepage 최대글자수 : [255자]	홈페이지
zipcode	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
country_code	국가코드
use_manufacturer	사용여부 T : 사용함 F : 사용안함

Request Copy

Response Copy

Update a manufacturer

PUT /api/v2/admin/manufacturers/{manufacturer_code}

PUT

쇼핑몰에 등록된 제조사의 정보를 수정합니다.
제조사명, 대표자명, 전화번호 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 쓰기권한 (mall.write_collection)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
manufacturer_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	제조사 코드
manufacturer_name	제조사명
president_name	대표자명
email 최대글자수 : [255자] 이메일	이메일
phone 최대글자수 : [20자] 전화번호	전화번호
homepage 최대글자수 : [255자]	홈페이지
zipcode	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
country_code	국가코드
use_manufacturer	사용여부 T : 사용함 F : 사용안함

Request Copy

Response Copy

Origin

원산지(Origin)는 상품정보에 포함되는 데이터로 상품이 생산된 지역을 의미합니다.
원산지는 국외 배송 등 경우에 따라 중요한 데이터가 될 수 있습니다.
카페24는 다양한 원산지가 코드화 되어있으며, 원산지 조회 API(List all origin)를 통해 원산지 코드 정보를 확인할 수 있습니다.

Endpoints

GET /api/v2/admin/origin

Origin properties

Attribute	Description
origin_place_no	원산지 번호
origin_place_name	원산지 이름
foreign	해외 여부
made_in_code	원산지 국가코드

Retrieve a list of origins

GET /api/v2/admin/origin

GET

쇼핑몰에서 제공하는 원산지를 목록으로 조회할 수 있습니다.
원산지 이름, 원산지 국가코드 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
origin_place_no	원산지 번호
origin_place_name 최대글자수 : [50자]	원산지 이름
foreign	해외 여부
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Request Copy

Response Copy

Trends

트렌드(Trends)는 상품의 "제작정보" 중 트렌드에 해당하는 정보에 대한 기능입니다.
트렌드는 상품을 구분하는 판매분류의 하나이며, 상품은 반드시 하나의 트렌드를 갖고 있습니다.(미지정시 "기본트렌드"를 사용함)

Endpoints

GET /api/v2/admin/trends
GET /api/v2/admin/trends/count

Trends properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
trend_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	트렌드 코드
trend_name 최대글자수 : [50자]	트렌드 명
use_trend	트렌드 사용여부 T : 사용함 F : 사용안함
created_date	생성일
product_count	상품수

Retrieve a list of trends

GET /api/v2/admin/trends

GET

쇼핑몰에 등록된 트렌드를 목록으로 조회할 수 있습니다.
트렌드 코드, 트렌드 명, 사용여부 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
trend_code	트렌드 코드 ,(콤마)로 여러 건을 검색할 수 있다.
trend_name	트렌드 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_trend	트렌드 사용여부 T : 사용함 F : 사용안함
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Request Copy

Response Copy

Retrieve a count of trends

GET /api/v2/admin/trends/count

GET

쇼핑몰에 등록된 트렌드의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	판매분류 읽기권한 (mall.read_collection)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
trend_code	트렌드 코드 ,(콤마)로 여러 건을 검색할 수 있다.
trend_name	트렌드 명 ,(콤마)로 여러 건을 검색할 수 있다.
use_trend	트렌드 사용여부 T : 사용함 F : 사용안함

Request Copy

Response Copy

Shipping suppliers

공급사 배송(Supplier Shipping)은 쇼핑몰의 각 공급사에 등록된 배송방법과 관련된 기능입니다.
각각의 공급사에게 등록된 배송방법에 대한 정보를 조회하거나 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/shipping/suppliers/{supplier_id}
PUT /api/v2/admin/shipping/suppliers/{supplier_id}

Shipping suppliers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
supplier_id	공급사 아이디
supplier_code	공급사 코드
shipping_method	배송방법 shipping_01 : 택배 shipping_02 : 빠른등기 shipping_04 : 직접배송 shipping_05 : 퀵배송 shipping_06 : 기타 shipping_07 : 화물배송 shipping_08 : 매장직접수령 shipping_09 : 배송필요 없음
shipping_etc 최대글자수 : [25자]	기타배송 배송방법(shipping_method)이 shipping_06(기타) 일 때 기타 배송 정보
shipping_type	국내/해외배송 설정 A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_place 최대글자수 : [127자]	배송지역
shipping_start_date 최소값: [1] 최대값: [100]	배송기간 시작일
shipping_end_date 최소값: [1] 최대값: [100]	배송기간 종료일
shipping_fee_type	배송비타입 T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
free_shipping_price 최소값: [0] 최대값: [999999999]	배송비 무료 최소금액 배송비타입(shipping_fee_type)이 "M(구매 금엑에 따른 부과)" 일 때 배송비를 무료로 만들기 위한 기준 금액
shipping_fee 최소값: [0] 최대값: [999999999]	배송비 배송비타입(shipping_fee_type)이 "R(고정배송비 사용)"이거나 "M(구매 금액에 따른 부과)"일 때 배송비 금액
shipping_fee_by_quantity 최소값: [0] 최대값: [999999999]	상품 수량별 배송비 배송비타입(shipping_fee_type)이 "N(상품 수량에 비례하여 배송료 부과)"일 때 수량별 배송비 금액
shipping_rates 배열 최대사이즈: [50]	배송비 상세 설정
prepaid_shipping_fee	배송비 선결제 설정 C : 착불 P : 선결제 B : 착불/선결제
shipping_fee_by_product	상품별 개별 배송료 설정 T : 사용함 F : 사용안함
product_weight 최소값: [0] 최대값: [30]	상품중량
hscode 최대글자수 : [20자]	HS코드
country_hscode 배열 최대사이즈: [50]	국가별 HS 코드

Retrieve a supplier's shipping settings

GET /api/v2/admin/shipping/suppliers/{supplier_id}

GET

공급사에게 등록된 배송방법에 대한 정보를 조회할 수 있습니다.
공급사 코드, 배송방법, 배송지역 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	30

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

supplier_id
Required

공급사 아이디

Request Copy

Response Copy

Update a supplier's shipping settings

PUT /api/v2/admin/shipping/suppliers/{supplier_id}

PUT

공급사에게 등록된 배송방법에 대한 정보를 수정할 수 있습니다.
배송방법, 배송지역, 배송비타입 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	30
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
supplier_id Required	공급사 아이디
shipping_method	배송방법 shipping_01 : 택배 shipping_02 : 빠른등기 shipping_04 : 직접배송 shipping_05 : 퀵배송 shipping_06 : 기타 shipping_07 : 화물배송 shipping_08 : 매장직접수령 shipping_09 : 배송필요 없음
shipping_etc 최대글자수 : [25자]	기타배송 배송방법(shipping_method)이 shipping_06(기타) 일 때 기타 배송 정보
shipping_type	국내/해외배송 설정 EC 베트남, 필리핀 버전에서는 사용할 수 없음. A : 국내배송 C : 해외배송 B : 국내/해외배송
shipping_place 최대글자수 : [127자]	배송지역
shipping_start_date 최소값: [1] 최대값: [100]	배송기간 시작일
shipping_end_date 최소값: [1] 최대값: [100]	배송기간 종료일
shipping_fee_type	배송비타입 T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
free_shipping_price 최소값: [0] 최대값: [999999999]	배송비 무료 최소금액 배송비타입(shipping_fee_type)이 "M(구매 금엑에 따른 부과)" 일 때 배송비를 무료로 만들기 위한 기준 금액
shipping_fee 최소값: [0] 최대값: [999999999]	배송비 배송비타입(shipping_fee_type)이 "R(고정배송비 사용)"이거나 "M(구매 금액에 따른 부과)"일 때 배송비 금액
shipping_fee_by_quantity 최소값: [0] 최대값: [999999999]	상품 수량별 배송비 배송비타입(shipping_fee_type)이 "N(상품 수량에 비례하여 배송료 부과)"일 때 수량별 배송비 금액
shipping_rates 배열 최대사이즈: [50]	배송비 상세 설정
shipping_rates_min 배송비 - 배송비 부과 기준 하한값 shipping_rates_max 배송비 - 배송비 부과 기준 상한값 shipping_fee 배송비
prepaid_shipping_fee	배송비 선결제 설정 EC 베트남, 필리핀 버전에서는 사용할 수 없음. C : 착불 P : 선결제 B : 착불/선결제
shipping_fee_by_product	상품별 개별 배송료 설정 T : 사용함 F : 사용안함
product_weight 최소값: [0] 최대값: [30]	상품중량
hscode 최대글자수 : [20자]	HS코드
country_hscode 배열 최대사이즈: [24]	국가별 HS 코드
country_code 국가코드 hscode HS코드

Request Copy

Response Copy

Suppliers

공급사(Suppliers)는 상품의 "제작정보" 중 공급사에 입력하는 정보를 의미합니다.
공급사는 쇼핑몰에 물품을 공급하여 상품을 팔 수 있게 하는 회사 또는 개인을 의미합니다.
공급사는 상품을 구분하는 판매분류의 하나이며, 상품은 반드시 하나의 공급사를 갖고 있습니다.(미지정시 "자체공급"을 사용함)

Endpoints

GET /api/v2/admin/suppliers
GET /api/v2/admin/suppliers/count
GET /api/v2/admin/suppliers/{supplier_code}
POST /api/v2/admin/suppliers
PUT /api/v2/admin/suppliers/{supplier_code}
DELETE /api/v2/admin/suppliers/{supplier_code}

Suppliers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
supplier_code	공급사 코드 시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [100자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.
status	상태 해당 공급사와의 거래 현황 정보. A : 거래중 P : 거래중지 N : 거래해지
commission	수수료 정산유형이 수수료형(P)일 경우 사용하는 수수료 정보
payment_period	정산주기 공급사에 정산을 얼마나 자주할 것인지 설정할 수 있음. 0 : 선택안함 C : 일일정산 B : 주간정산 A : 월간정산
business_item 최대글자수 : [255자]	거래상품 유형 공급사와 거래하는 상품의 유형 정보.
payment_type	정산유형 공급사에 지불할 금액을 어떤 유형으로 정산할 것인지 설정할 수 있음. 수수료형 : 상품의 판매가격에 수수료를 책정하여 수수료 금액을 반영하여 정산함 매입형 : 상품 등록시 입력한 공급가격을 기준으로 정산함 P : 수수료형 D : 매입형
supplier_type	공급사구조 공급사의 영업 형태. 도매업체 : 최종 고객에게는 판매하지 않고 소매업체에 판매하는 업체 사입업체 : 도매업체로부터 물건을 구입해서 소매업체에 판매하는 업체 입점업체 : 쇼핑몰에 입점하여 판매중인 업체 WS : 도매업체 SF : 사입업체 BS : 입점업체 ET : 기타
use_supplier	사용여부 해당 공급사를 사용하는지 여부 표시 T : 사용함 F : 사용안함
created_date	등록일 공급사 정보가 등록된 날짜
updated_date	수정일 공급사 정보가 수정된 날짜
country_code	사업장 주소 국가 코드
zipcode 최대글자수 : [10자]	우편번호 공급사의 사업장 주소 우편번호.
address1 최대글자수 : [255자]	기본 주소 공급사의 사업장 주소(시/군/구 단위 표기).
address2 최대글자수 : [255자]	상세 주소 공급사의 사업장 주소(상세 주소 표기).
manager_information	담당자 공급사의 담당자 연락처 정보. 담당자는 세명까지 지정 가능하다.
payment_start_day 최소: [0]~최대: [6]	정산시작 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_end_day 최소: [0]~최대: [6]	정산종료 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_start_date 최소: [1]~최대: [31]	정산시작 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산시작 일로 정함.
payment_end_date 최소: [1]~최대: [31]	정산종료 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산종료 일로 정함.
trading_type	공급사유형 상품이 공급사에서 배송되는 형태. 사입 : 상품을 판매자가 구입하여 구매자에게 배송함. 직배송 : 상품에 주문이 들어오면 공급사가 구매자에게 바로 배송함. D : 사입 C : 직배송
bank_code 최대글자수 : [50자]	은행코드 공급사 정산시 사용하는 계좌의 입금은행 코드 bank_code
bank_account_no	계좌번호 공급사 정산시 사용하는 계좌의 계좌 번호
bank_account_name	예금주 공급사 정산시 사용하는 계좌의 예금주 명
president_name	대표자명 사업자 등록시 공급사에서 등록한 대표자명
company_registration_no 최대글자수 : [12자]	사업자등록번호 해당 공급사의 사업자 등록 번호. 국가에 따라 해당 사업자의 등록 고유 번호가 발급되는 경우 표시한다.
company_name	상호명 사업자 등록시 공급사에서 등록한 상호명
company_condition	업태 사업자 등록시 공급사에서 등록한 업태
company_line	종목 사업자 등록시 공급사에서 등록한 종목
phone 최대글자수 : [20자]	전화번호 공급사의 사업장 전화번호.
fax 최대글자수 : [20자]	팩스번호 공급사의 사업장 팩스번호.
payment_method	정산시기 정산이 되는 기준 시점. 10 : 결제완료 30 : 배송시작 40 : 배송완료 10 : 결제완료 30 : 배송시작 40 : 배송완료
market_country_code	시장 주소 국가 코드
market_zipcode 최대글자수 : [10자]	시장주소 우편번호
market_address1	시장 기본 주소
market_address2	시장 상세 주소
exchange_country_code	반품 주소 국가 코드
exchange_zipcode 최대글자수 : [10자]	반품주소 우편번호
exchange_address1 최대글자수 : [255자]	반품 기본 주소
exchange_address2 최대글자수 : [255자]	반품 상세 주소
homepage_url 최대글자수 : [100자]	홈페이지 주소
mall_url 최대글자수 : [100자]	쇼핑몰 주소
account_start_date 최대글자수 : [10자]	거래개시일
account_stop_date 최대글자수 : [10자]	거래중지일
show_supplier_info 최대글자수 : [100자]	공급사정보 표시 SP : 전화번호 SM : 사업장주소 MA : 시장주소 EA : 반품주소 MN : 담당자명 MI : 담당자연락처
memo 최대글자수 : [255자]	메모 해당 공급사에 대한 관리용 메모
company_introduction	회사소개 공급사에 대한 간략한 소개 표시. 쇼핑몰의 회사 소개 화면에 표시된다.

Retrieve a list of suppliers

GET /api/v2/admin/suppliers

GET

쇼핑몰에 등록된 공급사들을 목록으로 조회할 수 있습니다.
공급사 코드, 공급사명, 수수료 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
supplier_code	공급사 코드 시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다. ,(콤마)로 여러 건을 검색할 수 있다.
supplier_name	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다. ,(콤마)로 여러 건을 검색할 수 있다.
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Request Copy

Response Copy

Retrieve a count of suppliers

GET /api/v2/admin/suppliers/count

GET

쇼핑몰에 등록된 전체 공급사의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

supplier_code

공급사 코드

시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.

,(콤마)로 여러 건을 검색할 수 있다.

supplier_name

공급사명

공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Retrieve a supplier

GET /api/v2/admin/suppliers/{supplier_code}

GET

특정 공급사의 정보를 조회할 수 있습니다.
공급사명, 수수료, 정산주기 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

supplier_code
Required

공급사 코드

시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.

Request Copy

Response Copy

Create a supplier

POST /api/v2/admin/suppliers

POST

쇼핑몰에 공급사를 신규로 생성할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
supplier_name Required 최대글자수 : [50자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.
manager_information 배열 최대사이즈: [3]	담당자 담당자는 최대 세명까지 입력할 수 있다.
no Required 담당자 일련번호 name Required 담당자 이름 phone 담당자 연락처 email 담당자 이메일
use_supplier	사용여부 해당 공급사를 사용하는지 여부 표시 T : 사용함 F : 사용안함 DEFAULT T
trading_type	공급사유형 상품이 공급사에서 배송되는 형태. 사입 : 상품을 판매자가 구입하여 구매자에게 배송함. 직배송 : 상품에 주문이 들어오면 공급사가 구매자에게 바로 배송함. D : 사입 C : 직배송 DEFAULT D
supplier_type	공급사구조 공급사의 영업 형태. 도매업체 : 최종 고객에게는 판매하지 않고 소매업체에 판매하는 업체 사입업체 : 도매업체로부터 물건을 구입해서 소매업체에 판매하는 업체 입점업체 : 쇼핑몰에 입점하여 판매중인 업체 WS : 도매업체 SF : 사입업체 BS : 입점업체 ET : 기타 DEFAULT WS
status	상태 해당 공급사와의 거래 현황 정보. A : 거래중 P : 거래중지 N : 거래해지 DEFAULT A
business_item 최대글자수 : [255자]	거래상품 유형 공급사와 거래하는 상품의 유형 정보.
payment_type	정산유형 공급사에 지불할 금액을 어떤 유형으로 정산할 것인지 설정할 수 있음. 수수료형 : 상품의 판매가격에 수수료를 책정하여 수수료 금액을 반영하여 정산함 매입형 : 상품 등록시 입력한 공급가격을 기준으로 정산함 P : 수수료형 D : 매입형 DEFAULT P
payment_period	정산주기 공급사에 정산을 얼마나 자주할 것인지 설정할 수 있음. 0 : 선택안함 C : 일일정산 B : 주간정산 A : 월간정산 DEFAULT 0
payment_method	정산시기 정산이 되는 기준 시점. 10 : 결제완료 30 : 배송시작 40 : 배송완료 10 : 결제완료 30 : 배송시작 40 : 배송완료
payment_start_day 최소: [0]~최대: [6]	정산시작 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_end_day 최소: [0]~최대: [6]	정산종료 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_start_date 최소: [1]~최대: [31]	정산시작 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산시작 일로 정함.
payment_end_date 최소: [1]~최대: [31]	정산종료 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산종료 일로 정함.
commission	수수료율 정산유형이 수수료형(P)일 경우 사용하는 수수료 정보 DEFAULT 10
phone 최대글자수 : [20자] 전화번호	전화번호 공급사의 사업장 전화번호.
fax 최대글자수 : [20자] 전화번호	팩스번호 공급사의 사업장 팩스번호.
country_code	사업장 주소 국가 코드
zipcode 최대글자수 : [10자]	우편번호 공급사의 사업장 주소 우편번호.
address1 최대글자수 : [255자]	기본 주소 공급사의 사업장 주소(시/군/구 단위 표기).
address2 최대글자수 : [255자]	상세 주소 공급사의 사업장 주소(상세 주소 표기).
market_country_code	시장 주소 국가 코드
market_zipcode 최대글자수 : [10자]	시장주소 우편번호
market_address1	시장 기본 주소
market_address2	시장 상세 주소
exchange_country_code	반품 주소 국가 코드
exchange_zipcode 최대글자수 : [10자]	반품주소 우편번호
exchange_address1 최대글자수 : [255자]	반품 기본 주소
exchange_address2 최대글자수 : [255자]	반품 상세 주소
homepage_url 최대글자수 : [100자]	홈페이지 주소
mall_url 최대글자수 : [100자]	쇼핑몰 주소
account_start_date 최대글자수 : [10자] 날짜	거래개시일
account_stop_date 최대글자수 : [10자] 날짜	거래중지일
memo 최대글자수 : [255자]	메모 해당 공급사에 대한 관리용 메모
company_registration_no 최대글자수 : [12자] 사업자번호	사업자등록번호 해당 공급사의 사업자 등록 번호. 국가에 따라 해당 사업자의 등록 고유 번호가 발급되는 경우 표시한다.
company_name 최대글자수 : [30자]	상호명 사업자 등록시 공급사에서 등록한 상호명
president_name 최대글자수 : [20자]	대표자명 사업자 등록시 공급사에서 등록한 대표자명
company_condition 최대글자수 : [20자]	업태 사업자 등록시 공급사에서 등록한 업태
company_line 최대글자수 : [20자]	종목 사업자 등록시 공급사에서 등록한 종목
company_introduction	회사소개 공급사에 대한 간략한 소개 표시. 쇼핑몰의 회사 소개 화면에 표시된다.

Request Copy

Response Copy

Update a supplier

PUT /api/v2/admin/suppliers/{supplier_code}

PUT

특정 공급사의 정보를 수정할 수 있습니다.
공급사명, 공급사유형 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
supplier_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드 시스템이 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [50자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.
use_supplier	사용여부 해당 공급사를 사용하는지 여부 표시 T : 사용함 F : 사용안함
trading_type	공급사유형 상품이 공급사에서 배송되는 형태. 사입 : 상품을 판매자가 구입하여 구매자에게 배송함. 직배송 : 상품에 주문이 들어오면 공급사가 구매자에게 바로 배송함. D : 사입 C : 직배송
supplier_type	공급사구조 공급사의 영업 형태. 도매업체 : 최종 고객에게는 판매하지 않고 소매업체에 판매하는 업체 사입업체 : 도매업체로부터 물건을 구입해서 소매업체에 판매하는 업체 입점업체 : 쇼핑몰에 입점하여 판매중인 업체 WS : 도매업체 SF : 사입업체 BS : 입점업체 ET : 기타
status	상태 해당 공급사와의 거래 현황 정보. A : 거래중 P : 거래중지 N : 거래해지
payment_type	정산유형 공급사에 지불할 금액을 어떤 유형으로 정산할 것인지 설정할 수 있음. 수수료형 : 상품의 판매가격에 수수료를 책정하여 수수료 금액을 반영하여 정산함 매입형 : 상품 등록시 입력한 공급가격을 기준으로 정산함 P : 수수료형 D : 매입형
payment_period	정산주기 공급사에 정산을 얼마나 자주할 것인지 설정할 수 있음. 0 : 선택안함 C : 일일정산 B : 주간정산 A : 월간정산
commission	수수료율 정산유형이 수수료형(P)일 경우 사용하는 수수료 정보
manager_information 배열 최대사이즈: [3]	담당자 담당자는 세명까지 지정할 수 있으며, "no"를 통해 특정 담당자를 지정하여 정보를 수정할 수 있다.
no Required 담당자 일련번호 name Required 담당자 이름 phone 담당자 연락처 email 담당자 이메일 use_sms SMS 수신여부 T : 수신 F : 수신안함
business_item 최대글자수 : [255자]	거래상품 유형 공급사와 거래하는 상품의 유형 정보.
payment_method	정산시기 정산이 되는 기준 시점. 10 : 결제완료 30 : 배송시작 40 : 배송완료 10 : 결제완료 30 : 배송시작 40 : 배송완료
payment_start_day 최소: [0]~최대: [6]	정산시작 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_end_day 최소: [0]~최대: [6]	정산종료 요일 정산주기가 주간정산(B)일 경우 아래 요일에 따라 정산이 진행됨. 0 : 일요일마다 정산 진행 1 : 월요일마다 정산 진행 2 : 화요일마다 정산 진행 3 : 수요일마다 정산 진행 4 : 목요일마다 정산 진행 5 : 금요일마다 정산 진행 6 : 토요일마다 정산 진행 0 : 일요일 1 : 월요일 2 : 화요일 3 : 수요일 4 : 목요일 5 : 금요일 6 : 토요일
payment_start_date 최소: [1]~최대: [31]	정산시작 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산시작 일로 정함.
payment_end_date 최소: [1]~최대: [31]	정산종료 일 정산주기가 월간정산(A)일 경우 해당 일자를 정산종료 일로 정함.
phone 최대글자수 : [20자] 전화번호	전화번호 공급사의 사업장 전화번호.
fax 최대글자수 : [20자] 전화번호	팩스번호 공급사의 사업장 팩스번호.
country_code	사업장 주소 국가 코드
zipcode 최대글자수 : [10자]	우편번호 공급사의 사업장 주소 우편번호.
address1 최대글자수 : [255자]	기본 주소 공급사의 사업장 주소(시/군/구 단위 표기).
address2 최대글자수 : [255자]	상세 주소 공급사의 사업장 주소(상세 주소 표기).
market_country_code	시장 주소 국가 코드
market_zipcode 최대글자수 : [10자]	시장주소 우편번호
market_address1	시장 기본 주소
market_address2	시장 상세 주소
exchange_country_code	반품 주소 국가 코드
exchange_zipcode 최대글자수 : [10자]	반품주소 우편번호
exchange_address1 최대글자수 : [255자]	반품 기본 주소
exchange_address2 최대글자수 : [255자]	반품 상세 주소
homepage_url 최대글자수 : [100자]	홈페이지 주소
mall_url 최대글자수 : [100자]	쇼핑몰 주소
account_start_date 최대글자수 : [10자] 날짜	거래개시일
account_stop_date 최대글자수 : [10자] 날짜	거래중지일
memo 최대글자수 : [255자]	메모 해당 공급사에 대한 관리용 메모
company_registration_no 최대글자수 : [12자] 사업자번호	사업자등록번호 해당 공급사의 사업자 등록 번호. 국가에 따라 해당 사업자의 등록 고유 번호가 발급되는 경우 표시한다.
company_name 최대글자수 : [30자]	상호명 사업자 등록시 공급사에서 등록한 상호명
president_name 최대글자수 : [20자]	대표자명 사업자 등록시 공급사에서 등록한 대표자명
company_condition 최대글자수 : [20자]	업태 사업자 등록시 공급사에서 등록한 업태
company_line 최대글자수 : [20자]	종목 사업자 등록시 공급사에서 등록한 종목
company_introduction	회사소개 공급사에 대한 간략한 소개 표시. 쇼핑몰의 회사 소개 화면에 표시된다.

Request Copy

Response Copy

Delete a supplier

DELETE /api/v2/admin/suppliers/{supplier_code}

DELETE

쇼핑몰에 생성된 공급사를 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40

요청사양

Parameter	Description
supplier_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드

Request Copy

Response Copy

Suppliers users

공급사 운영자(Supplier Users)는 공급사가 쇼핑몰에 로그인하여 상품을 직접 등록해야할 경우 필요합니다.
공급사 운영자에게 상품 업로드, 분류 관리, 게시판 관리 등 제한적인 권한을 부여할 수 있습니다.

Endpoints

GET /api/v2/admin/suppliers/users
GET /api/v2/admin/suppliers/users/count
GET /api/v2/admin/suppliers/users/{user_id}
POST /api/v2/admin/suppliers/users
PUT /api/v2/admin/suppliers/users/{user_id}
DELETE /api/v2/admin/suppliers/users/{user_id}

Suppliers users properties

Attribute	Description
user_id 형식 : [a-z0-9] 글자수 최소: [4자]~최대: [16자]	공급사 운영자 아이디 공급사 운영자가 로그인할 경우 사용하는 로그인 아이디. 부운영자와 마찬가지로 쇼핑몰 관리자 화면에 로그인하면 공급사 관리자 화면에 접근할 수 있다.
supplier_code 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드 시스템에서 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [100자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.
permission_category_select	상품 등록 시 분류선택 권한 공급사 운영자가 상품 등록시 상품 분류를 선택하여 등록할 수 있는지에 대한 권한 설정
permission_product_modify	상품 수정 권한 공급사 운영자가 상품을 등록한 후 상품 정보를 수정할 수 있는 권한 설정
permission_product_display	상품 진열 권한 공급사 운영자가 상품을 등록한 후 쇼핑몰 화면에 진열할 수 있는 권한 설정
permission_product_selling	상품 판매 권한 공급사 운영자가 상품을 등록한 후 해당 상품의 판매여부를 설정할 수 있는 권한 설정
permission_product_delete	등록 상품 삭제 권한 공급사 운영자가 자신이 등록한 상품을 삭제할 수 있는 권한 설정
permission_amount_inquiry	주문 금액 조회 권한
permission_board_manage	게시판 권한 설정 공급사 운영자가 쇼핑몰의 게시판에 접근할 수 있는 권한 설정 T : 허용함 F : 허용안함
permission_order_menu	주문 메뉴 접근 권한
user_name	공급사운영자명 공급사 운영자의 이름. 공급사 운영자 명은 공급사 운영자가 쇼핑몰 관리자 화면에서 어떤 작업을 할 경우 "작업을 실행한 사람(처리자)" 부분에 표시되는 이름을 의미한다. 공급사 운영자 상세 조회 API에서만 확인 가능하다.
nick_name	별명 공급사 운영자의 별명. 공급사 운영자 별명은 공급사 운영자가 게시판에 게시글 작성할 경우 "게시자" 부분에 표시되는 별명을 의미한다.(단, 해당 게시판이 작성자명 대신 '별명'을 노출하도록 설정되어있을 경우에 한 함) 공급사 운영자 상세 조회 API에서만 확인 가능하다.
nick_name_icon_type	별명 아이콘 타입 공급사 운영자의 별명 옆에 표시되는 아이콘을 설정할 수 있다. 직접 아이콘 등록 : 별명 아이콘을 직접 업로드하여 설정할 수 있다. 샘플 아이콘 등록 : 미리 제공되는 아이콘을 선택하여 설정할 수 있다. 공급사 운영자 상세 조회 API에서만 확인 가능하다. D : 직접 S : 샘플
nick_name_icon_url 최대글자수 : [255자]	별명 아이콘 URL 공급사 운영자의 별명 아이콘의 이미지 경로. 공급사 운영자 상세 조회 API에서만 확인 가능하다.
use_nick_name_icon	게시판 닉네임 아이콘 노출 설정 공급사 운영자가 게시판에 게시글 작성시 별명 아이콘을 노출할 것인지 여부 표시 공급사 운영자 상세 조회 API에서만 확인 가능하다.
use_writer_name_icon	게시판 작성자 노출 설정 공급사 운영자가 게시판에 게시글 작성시 작성자 명을 노출할 것인지 여부 표시 공급사 운영자 상세 조회 API에서만 확인 가능하다.
email 이메일	이메일 공급사 운영자의 이메일 주소. 공급사 운영자의 연락처 저장 목적으로 사용함. 공급사 운영자 상세 조회 API에서만 확인 가능하다.
phone	전화번호 공급사 운영자의 전화번호. 공급사 운영자의 연락처 저장 목적으로 사용함. 공급사 운영자 상세 조회 API에서만 확인 가능하다.
permission_shop_no	접근가능 쇼핑몰 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
permitted_category_list	상품 등록시 허용 상품분류 공급사 운영자가 상품 등록시 선택 가능한 상품 분류. 공급사 운영자는 상품 등록시 해당 상품 분류에만 상품을 올릴 수 있다. 공급사 운영자 상세 조회 API에서만 확인 가능하다.

Retrieve a list of supplier users

GET /api/v2/admin/suppliers/users

GET

쇼핑몰에 등록된 공급사 운영자를 목록으로 조회할 수 있습니다.
공급사 코드, 공급사명, 공급사운영자명 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
user_id 형식 : [a-zA-Z0-9] 글자수 최소: [4자]~최대: [16자]	공급사 운영자 아이디 공급사 운영자가 로그인할 경우 사용하는 로그인 아이디. 부운영자와 마찬가지로 쇼핑몰 관리자 화면에 로그인하면 공급사 관리자 화면에 접근할 수 있다.
supplier_code 최대글자수 : [8자]	공급사 코드 시스템에서 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [100자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.

Request Copy

Response Copy

Retrieve a count of supplier users

GET /api/v2/admin/suppliers/users/count

GET

쇼핑몰에 등록된 공급사 운영자의 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	10

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
user_id 형식 : [a-zA-Z0-9] 글자수 최소: [4자]~최대: [16자]	공급사 운영자 아이디 공급사 운영자가 로그인할 경우 사용하는 로그인 아이디. 부운영자와 마찬가지로 쇼핑몰 관리자 화면에 로그인하면 공급사 관리자 화면에 접근할 수 있다.
supplier_code 최대글자수 : [8자]	공급사 코드 시스템에서 부여한 공급사의 코드. 해당 쇼핑몰 내에서 공급사 코드는 중복되지 않는다.
supplier_name 최대글자수 : [100자]	공급사명 공급사의 이름. 공급사명은 쇼핑몰 관리자 화면에서 공급사를 구분할 수 있는 기본적인 정보이다.

Request Copy

Response Copy

Retrieve supplier user details

GET /api/v2/admin/suppliers/users/{user_id}

GET

쇼핑몰에 등록된 특정 공급사 운영자를 조회할 수 있습니다.
공급사명, 공급사의 권한, 별명 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	10

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

user_id

형식 : [a-zA-Z0-9]
글자수 최소: [4자]~최대: [16자]

공급사 운영자 아이디

공급사 운영자가 로그인할 경우 사용하는 로그인 아이디. 부운영자와 마찬가지로 쇼핑몰 관리자 화면에 로그인하면 공급사 관리자 화면에 접근할 수 있다.

Request Copy

Response Copy

Create a supplier user

POST /api/v2/admin/suppliers/users

POST

쇼핑몰에 공급사 운영자를 새로이 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
user_id Required 형식 : [a-z0-9] 글자수 최소: [4자]~최대: [16자]	공급사 운영자 아이디
supplier_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	공급사 코드
user_name	공급사운영자명 필수 입력 필요
shop_no Required 멀티쇼핑몰 번호 user_name Required 공급사운영자명
nick_name	별명
shop_no 멀티쇼핑몰 번호 nick_name 별명
password Required	접속 비밀번호
use_nick_name_icon	게시판 닉네임 아이콘 노출 설정 T : 사용함 F : 사용안함 DEFAULT F
use_writer_name_icon	게시판 작성자 노출 설정 T : 사용함 F : 사용안함 DEFAULT F
email 이메일	이메일
phone	전화번호
permission_shop_no Required	접근가능 쇼핑몰
permission_category_select	상품 등록 시 분류선택 권한 T : 사용함 F : 사용안함 DEFAULT T
permitted_category_list	상품 등록시 허용 상품분류
permission_product_modify	상품 수정 권한 T : 사용함 F : 사용안함 DEFAULT T
permission_product_display	상품 진열 권한 T : 사용함 F : 사용안함 DEFAULT T
permission_product_selling	상품 판매 권한 T : 사용함 F : 사용안함 DEFAULT T
permission_product_delete	등록 상품 삭제 권한 T : 사용함 F : 사용안함 DEFAULT T
permission_order_menu	주문 메뉴 접근 권한 T : 사용함 F : 사용안함 DEFAULT T
permission_amount_inquiry	주문 금액 조회 권한 T : 사용함 F : 사용안함 DEFAULT F

Request Copy

Response Copy

Update a supplier user

PUT /api/v2/admin/suppliers/users/{user_id}

PUT

쇼핑몰에 등록된 특정 공급사 운영자의 정보를 수정할 수 있습니다.
공급사운영자명, 별명, 비밀번호 등을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
user_id Required 형식 : [a-z0-9] 글자수 최소: [4자]~최대: [16자]	공급사 운영자 아이디
user_name	공급사운영자명 필수 입력 필요
shop_no 멀티쇼핑몰 번호 user_name 공급사운영자명
nick_name	별명
shop_no 멀티쇼핑몰 번호 nick_name 별명
password	접속 비밀번호
use_nick_name_icon	게시판 닉네임 아이콘 노출 설정 T : 사용함 F : 사용안함
use_writer_name_icon	게시판 작성자 노출 설정 T : 사용함 F : 사용안함
email 이메일	이메일
phone	전화번호
permission_shop_no	접근가능 쇼핑몰
permission_category_select	상품 등록 시 분류선택 권한 T : 사용함 F : 사용안함
permitted_category_list	상품 등록시 허용 상품분류
permission_product_modify	상품 수정 권한 T : 사용함 F : 사용안함
permission_product_display	상품 진열 권한 T : 사용함 F : 사용안함
permission_product_selling	상품 판매 권한 T : 사용함 F : 사용안함
permission_product_delete	등록 상품 삭제 권한 T : 사용함 F : 사용안함
permission_order_menu	주문 메뉴 접근 권한 T : 사용함 F : 사용안함
permission_amount_inquiry	주문 금액 조회 권한 T : 사용함 F : 사용안함

Request Copy

Response Copy

Delete a supplier user

DELETE /api/v2/admin/suppliers/users/{user_id}

DELETE

쇼핑몰에 등록된 특정 공급사 운영자를 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40

요청사양

Parameter	Description
user_id Required 형식 : [a-z0-9] 글자수 최소: [4자]~최대: [16자]	공급사 운영자 아이디

Request Copy

Response Copy

Suppliers users regionalsurcharges

공급사 지역별 배송비(Suppliers users regionalsurcharges)를 통해 공급사별로 지역별 배송비를 설정하거나, 설정된 정보를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges
POST /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges
DELETE /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/{regional_surcharge_no}

Suppliers users regionalsurcharges properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
regional_surcharge_no	지역별 배송비 등록 번호
supplier_id 최대글자수 : [20자]	공급사 아이디
country_code 최대글자수 : [2자]	국가코드 KR : 대한민국 JP : 일본 VN : 베트남
region_name 최대글자수 : [255자]	특수지역명
surcharge_region_name 최대글자수 : [300자]	지역명 추가배송비를 부과할 지역이름 지역 설정방식(region_setting_type)이 'N'으로 설정 되어있는 경우 필수 입력
start_zipcode 최대글자수 : [8자]	시작 우편번호 지역 설정 방식(region_setting_type)이 'Z'로 설정 되어있는 경우 필수 입력
end_zipcode 최대글자수 : [8자]	끝 우편번호 지역 설정 방식(region_setting_type)이 'Z'로 설정 되어있는 경우 필수 입력
regional_surcharge_amount 최소: [1]~최대: [999999999]	지역 추가 배송비 부과할 추가배송비 금액
use_regional_surcharge	지역별 배송비 사용여부 T : 사용함 F : 사용안함

Retrieve a supplier user's list of regional shipping fees

GET /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges

GET

특정 공급사의 등록된 지역별 배송비 설정을 목록으로 조회할 수 있습니다.
국가코드, 지역명, 지역 추가 배송비 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
supplier_id Required 최대글자수 : [20자]	공급사 아이디
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Create regional shipping fee for a supplier user

POST /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges

POST

특정 공급사의 지역별 배송비 설정을 등록할 수 있습니다.
공급사 하나당 지역별로 여러 배송비를 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
supplier_id Required 최대글자수 : [20자]	공급사 아이디
country_code 최대글자수 : [2자]	국가코드 EC 한국, 일본, 베트남, 필리핀 버전에서는 사용할 수 없음. KR : 대한민국 JP : 일본 VN : 베트남
region_name Required 최대글자수 : [255자]	특수지역명
use_regional_surcharge Required	지역별 배송비 사용여부 T : 사용함 F : 사용안함
surcharge_region_name 최대글자수 : [300자]	지역명
start_zipcode 최대글자수 : [8자]	시작 우편번호
end_zipcode 최대글자수 : [8자]	끝 우편번호
regional_surcharge_amount Required 최소: [1]~최대: [999999999]	지역 추가 배송비

Request Copy

Response Copy

Delete supplier user's regional shipping fee settings

DELETE /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/{regional_surcharge_no}

DELETE

특정 공급사의 등록된 지역별 배송비 설정을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

supplier_id
Required

최대글자수 : [20자]

공급사 아이디

regional_surcharge_no
Required

지역별 배송비 등록 번호

Request Copy

Response Copy

Suppliers users regionalsurcharges setting

공급사 지역별 배송비 설정(Suppliers users regionalsurcharges setting)을 통해 공급사별로 지역별 배송비를 설정값을 조회하거나 수정할 수 있습니다.

Endpoints

GET /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/setting
PUT /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/setting

Suppliers users regionalsurcharges setting properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
supplier_id 최대글자수 : [20자]	공급사 아이디
use_regional_surcharge	지역별 배송비 사용여부 T : 사용함 F : 사용안함
region_setting_type	지역 설정 방식 A : 간편 설정 N : 지명 설정 Z : 우편번호 설정
jeju_surcharge_amount 최소: [0]~최대: [999999999]	제주 추가 배송비
remote_area_surcharge_amount 최소: [0]~최대: [999999999]	도서산간 추가 배송비

Retrieve a supplier user's regional shipping fee settings

GET /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/setting

GET

특정 공급사의 지역별 배송비 설정을 조회할 수 있습니다.
지역별 배송비 사용 여부와 지역 설정 방식을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 읽기권한 (mall.read_supply)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

supplier_id
Required

최대글자수 : [20자]

공급사 아이디

Request Copy

Response Copy

Update a supplier user's regional shipping fee settings

PUT /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/setting

PUT

특정 공급사의 지역별 배송비 설정을 수정할 수 있습니다.
지역별 배송비 사용 여부와 지역 설정 방식을 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	공급사 정보 쓰기권한 (mall.write_supply)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
supplier_id Required 최대글자수 : [20자]	공급사 아이디
use_regional_surcharge Required	지역별 배송비 사용여부 T : 사용함 F : 사용안함
region_setting_type Required	지역 설정 방식 A : 간편 설정 N : 지명 설정 Z : 우편번호 설정
jeju_surcharge_amount 최소: [0]~최대: [999999999]	제주 추가 배송비
remote_area_surcharge_amount 최소: [0]~최대: [999999999]	도서산간 추가 배송비

Request Copy

Response Copy

Carriers

배송사(Carriers)는 쇼핑몰로부터 쇼핑몰 고객에게까지 상품을 배송하는 주체입니다.
배송사를 등록하면 쇼핑몰에서 배송처리시 해당 배송사를 선택하여 배송 처리를 진행할 수 있습니다.
배송사 리소스에서는 현재 등록되어있는 배송사를 조회하고 배송사를 생성, 수정, 삭제처리할 수 있습니다.

Endpoints

GET /api/v2/admin/carriers
GET /api/v2/admin/carriers/{carrier_id}
POST /api/v2/admin/carriers
PUT /api/v2/admin/carriers/{carrier_id}
DELETE /api/v2/admin/carriers/{carrier_id}

Carriers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
carrier_id	배송사 아이디
shipping_carrier_code	배송사 코드 shipping_company_code
shipping_carrier	배송사 명
track_shipment_url	배송추적 URL
shipping_type	국내/해외배송 설정 A : 국내 B : 국내/해외 C : 해외
contact	대표 연락처
secondary_contact	보조 연락처
email	이메일
default_shipping_fee	기본 배송비
homepage_url	홈페이지 주소
default_shipping_carrier	기본배송사 여부 T : 사용함 F : 사용안함
shipping_fee_setting	배송비 설정 여부 T : 사용함 F : 사용안함
shipping_fee_setting_detail	배송비 설정 데이터
express_exception_setting	연동택배 예외정보 설정
links	link

Retrieve a list of shipping carriers

GET /api/v2/admin/carriers

GET

생성된 배송사를 목록으로 조회할 수 있습니다.
배송사명, 배송사 코드, 배송비 설정 데이터 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 읽기권한 (mall.read_shipping)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Retrieve a shipping carrier

GET /api/v2/admin/carriers/{carrier_id}

GET

특정 배송사 하나를 선택하여 상세조회할 수 있습니다.
배송사명, 배송사 코드, 배송비 설정 데이터 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 읽기권한 (mall.read_shipping)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

carrier_id
Required

배송업체 아이디

Request Copy

Response Copy

Create a shipping carrier

POST /api/v2/admin/carriers

POST

배송사를 생성할 수 있습니다.
배송사를 생성하면서 배송사별로 배송비 설정도 진행할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 쓰기권한 (mall.write_shipping)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
shipping_carrier_code Required	배송사 코드 shipping_company_code
contact Required 최대글자수 : [16자]	대표 연락처
email Required 이메일 최대글자수 : [255자]	이메일
shipping_carrier 최대글자수 : [80자]	배송사 명
track_shipment_url 최대글자수 : [255자]	배송추적 URL
secondary_contact 최대글자수 : [16자]	보조 연락처
default_shipping_fee	기본 배송비
homepage_url 최대글자수 : [255자]	홈페이지 주소
shipping_fee_setting	배송비 설정 여부 T : 사용함 F : 사용안함 DEFAULT F
shipping_fee_setting_detail	배송비 설정 데이터 ※shipping_fee_setting_detail의 하위요소에 대한 값 정의 1)shipping_fee_setting_domestic > shipping_fee_type shipping_fee_type(배송비 설정) T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과 2)shipping_fee_setting_domestic > shipping_fee_criteria shipping_fee_criteria(배송비 청구 기준 주문금액 조건 설정) D : 할인전, 정상판매가격 기준(권장) A : 할인 적용 후 결제 금액 기준 3)shipping_fee_setting_oversea > additional_handling_fee_list > unit unit(해외배송 부가금액 단위) W : 정액 P : 퍼센트 4)shipping_fee_setting_oversea > additional_handling_fee_list > rounding_unit rounding_unit(해외배송 부가금액 절사단위) F : 절사안함 0 : 1단위 1 : 10단위 2 : 100단위 3 : 1000단위 5)shipping_fee_setting_oversea > additional_handling_fee_list > rounding_rule rounding_rule(해외배송 부가금액 절사방식) L : 내림 U : 반올림 C : 올림
shipping_type 국내/해외배송 설정 A : 국내 B : 국내/해외 C : 해외 DEFAULT B available_shipping_zone 배송가능 지역 min_shipping_period 배송가능 최소일 max_shipping_period 배송가능 최대일 shipping_information 주문서 배송안내 shipping_fee_setting_domestic Array shipping_fee_type 배송비 설정 shipping_fee 배송비 min_price 미만 조건금액 use_product_category 선택 상품분류 적용 product_category_list Array category_no 카테고리 번호 shipping_fee_criteria 배송비 청구 기준 주문금액 조건 설정 domestic_shipping_fee_list Array min_value 구간 금액 min max_value 구간 금액 max shipping_fee 배송비 available_shipping_zone 배송가능 지역 설정 여부 available_shipping_zone_list Array region 배송가능지역 명 start_zipcode 시작 우편번호 end_zipcode 끝 우편번호 available_order_time 주문가능 시간 설정 start_time 주문가능 시작 시간 end_time 주문가능 마감 시간 shipping_fee_setting_oversea Array shipping_fee_criteria 배송비 청구 기준 주문금액 조건 설정 shipping_country_list Array country_code 국가코드 country_shipping_fee_list Array country_code 국가코드 conditional 구간 조건 min_value 구간 금액 min max_value 구간 금액 max shipping_fee 배송비 additional_handling_fee 해외배송 부가금액 여부 additional_handling_fee_list Array country_code 국가코드 text 부과금액 명칭 min_value 구간 금액 min max_value 구간 금액 max additional_handling_fee 해외배송 부가금액 unit 해외배송 부가금액 단위 rounding_unit 절사단위 rounding_rule 절사 방법 maximum_quantity 총 구매수량 제한 product_category_limit 상품분류 제한 여부 product_category_limit_list Array category_no 카테고리 번호 product_maximum_quantity 상품분류별 구매수량 제한

Request Copy

Response Copy

Update a shipping carrier

PUT /api/v2/admin/carriers/{carrier_id}

PUT

특정 배송사를 수정할 수 있습니다.
기본배송사 여부 설정값을 변경할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 쓰기권한 (mall.write_shipping)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

carrier_id
Required

배송사 아이디

default_shipping_carrier

기본배송사 여부

T : 사용함
F : 사용안함

DEFAULT T

Request Copy

Response Copy

Delete a shipping carrier

DELETE /api/v2/admin/carriers/{carrier_id}

DELETE

특정 배송사를 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 쓰기권한 (mall.write_shipping)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

DEFAULT 1

carrier_id
Required

배송사 아이디

delete_default_carrier

기본배송사 삭제 여부

T : 삭제함
F : 삭제안함

DEFAULT F

Request Copy

Response Copy

Shipping

배송(Shipping)은 쇼핑몰에 등록된 배송방법과 관련된 기능입니다.
각각의 배송방법에 대한 상세 정보를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/shipping
PUT /api/v2/admin/shipping

Shipping properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
shipping_method	배송방법 shipping_01 : 택배 shipping_02 : 빠른등기 shipping_04 : 직접배송 shipping_05 : 퀵배송 shipping_06 : 기타 shipping_07 : 화물배송 shipping_08 : 매장직접수령 shipping_09 : 배송필요 없음
shipping_etc	기타배송
shipping_type	국내/해외배송 설정 A : 국내배송 C : 해외배송 B : 국내/해외배송
international_shipping_fee_criteria	해외 배송비 기준 설정 B : 쇼핑몰 자체 배송비 E : 자동 책정 배송비(EMS)
shipping_period	배송기간
shipping_fee_type	배송비타입 T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_fee 최대값: [999999999]	배송비
free_shipping_price 최대값: [99999999999999]	배송비 무료 최소금액 배송비 설정 > 구매 금액에 따른 부과 일 경우 사용
shipping_fee_by_quantity 최대값: [999999999]	상품 수량별 배송비 배송비 설정 > 상품 수량에 비례하여 배송료 부과 일 경우 사용
shipping_rates	배송비 상세 설정
shipping_fee_criteria	배송비 청구 기준 주문금액 조건 설정 D : 할인전 정상판매가격 기준(권장) L : 최종 주문(결제)금액 기준 A : 할인 적용 후 결제 금액 기준 R : 최종 실 결제금액 기준
prepaid_shipping_fee	배송비 선결제 설정 C : 착불 P : 선결제 B : 착불/선결제
product_weight	상품중량
oversea_shipping_country	해외배송가능 국가 제한 여부 T : 제한함 F : 제한안함
oversea_shipping_country_list	배송국가
country_shipping_fee	배송비 국가별 개별 설정 여부 T : 사용함 F : 사용안함
country_shipping_fee_list	국가별 배송비
international_shipping_insurance	해외배송 보험료 T : 사용함 F : 사용안함
return_address	반품주소
package_volume	배송규격
wished_delivery_date	희망배송일
wished_delivery_time	희망배송시간
hs_code	HS코드
country_hs_code	국가별 HS 코드
supplier_shipping_fee	공급사 배송비 사용 여부 T : 사용함 F : 사용안함

Retrieve shipping / return settings

GET /api/v2/admin/shipping

GET

쇼핑몰에 등록된 배송방법에 대한 정보를 목록으로 조회할 수 있습니다.
배송방법, 배송기간, 배송비 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 읽기권한 (mall.read_shipping)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Update store shipping/return settings

PUT /api/v2/admin/shipping

PUT

쇼핑몰에 등록된 배송방법에 대한 정보를 수정할 수 있습니다.
배송방법, 배송기간 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 쓰기권한 (mall.write_shipping)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
shipping_method	배송방법 shipping_01 : 택배 shipping_02 : 빠른등기 shipping_04 : 직접배송 shipping_05 : 퀵배송 shipping_06 : 기타 shipping_07 : 화물배송 shipping_08 : 매장직접수령 shipping_09 : 배송필요 없음
shipping_etc 최대글자수 : [25자]	기타배송
shipping_period	배송기간
minimum 최소 기간 maximum 최대 기간
shipping_fee_type	배송비타입 T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과
shipping_fee 최대값: [999999999]	배송비
free_shipping_price 최대값: [99999999999999]	배송비 무료 최소금액
shipping_fee_by_quantity 최대값: [999999999]	상품 수량별 배송비
shipping_rates	배송비 상세 설정
min_value 조건 최소값 max_value 조건 최대값 shipping_fee 배송비
shipping_fee_criteria	배송비 청구 기준 주문금액 조건 설정 D : 할인전 정상판매가격 기준(권장) A : 할인 적용 후 결제 금액 기준
prepaid_shipping_fee	배송비 선결제 설정 EC 일본, 베트남, 필리핀 버전에서는 사용할 수 없음. C : 착불 P : 선결제 B : 착불/선결제
product_weight 최소값: [0] 최대값: [30]	상품중량
oversea_shipping_country	해외배송가능 국가 제한 여부 T : 제한함 F : 제한안함
oversea_shipping_country_list	배송국가
country_code 국가코드
country_shipping_fee	배송비 국가별 개별 설정 여부 EC 일본, 베트남, 필리핀 버전에서는 사용할 수 없음. T : 사용함 F : 사용안함
country_shipping_fee_list	국가별 배송비 EC 일본, 베트남, 필리핀 버전에서는 사용할 수 없음.
country_code 국가코드 conditional 배송비 책정 조건 quantity : 수량 weight : 무게 price : 가격 min_value 조건 최소값 max_value 조건 최대값 shipping_fee 배송비
international_shipping_insurance	해외배송 보험료 EC 한국 버전에서만 사용할 수 있음. T : 사용함 F : 사용안함
return_address	반품주소
zipcode 우편번호 ziptype 우편번호 선택 국가 address1 기본 주소 address2 상세 주소
package_volume	배송규격
width 가로 length 세로 height 높이

Request Copy

Response Copy

Shippingorigins

출고지 관리(Shipping origins)는 출고지에 대한 정보를 관리하는 기능입니다.

Endpoints

GET /api/v2/admin/shippingorigins
GET /api/v2/admin/shippingorigins/{origin_code}
POST /api/v2/admin/shippingorigins
PUT /api/v2/admin/shippingorigins/{origin_code}
DELETE /api/v2/admin/shippingorigins/{origin_code}

Shippingorigins properties

Attribute	Description
origin_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	출고지 코드
origin_name 최대글자수 : [50자]	출고지 명
default	출고지 기본설정 여부 T : 사용함 F : 사용안함
country_code 최대글자수 : [2자]	국가코드
zipcode 최소글자수 : [2자] 최대글자수 : [14자]	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
contact	대표 연락처
secondary_contact	보조 연락처
variants	출고지 품목 정보

Retrieve a list of shipping origins

GET /api/v2/admin/shippingorigins

GET

등록된 출고지를 목록으로 조회할 수 있습니다.
품목 정보는 최대 100건까지 표기됩니다.

기본스펙

Property	Description
SCOPE	배송 읽기권한 (mall.read_shipping)
호출건수 제한	40

요청사양

Parameter

Description

offset

최대값: [8000]

조회결과 시작위치

DEFAULT 0

limit

최소: [1]~최대: [100]

조회결과 최대건수

DEFAULT 10

Request Copy

Response Copy

Retrieve a shipping origin

GET /api/v2/admin/shippingorigins/{origin_code}

GET

등록된 출고지를 상세 조회할 수 있습니다.
품목 정보가 100건 이후의 모든 값이 조회됩니다.

기본스펙

Property	Description
SCOPE	배송 읽기권한 (mall.read_shipping)
호출건수 제한	40

요청사양

Parameter	Description
origin_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	출고지 코드

Request Copy

Response Copy

Create a shipping origin

POST /api/v2/admin/shippingorigins

POST

배송 출고지로 활용될 출고지를 등록할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 쓰기권한 (mall.write_shipping)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
origin_name Required 최대글자수 : [50자]	출고지 명
address1 Required 최대글자수 : [255자]	기본 주소
address2 Required 최대글자수 : [255자]	상세 주소
country_code Required 최대글자수 : [2자]	국가코드
default	출고지 기본설정 여부 T : 사용함 F : 사용안함 DEFAULT F
zipcode 최소글자수 : [2자] 최대글자수 : [14자]	우편번호
contact 전화번호 최대글자수 : [20자]	대표 연락처
secondary_contact 전화번호 최대글자수 : [20자]	보조 연락처

Request Copy

Response Copy

Update a shipping origin

PUT /api/v2/admin/shippingorigins/{origin_code}

PUT

배송 출고지로 활용될 출고지를 등록할 수 있습니다.
배송 관리자 활성화 시, 상품 및 품목별 출고지를 설정할 수 있습니다.

기본스펙

Property	Description
SCOPE	배송 쓰기권한 (mall.write_shipping)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
origin_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	출고지 코드
origin_name 최대글자수 : [50자]	출고지 명
country_code 최대글자수 : [2자]	국가코드
default	출고지 기본설정 여부 T : 사용함 F : 사용안함
contact 전화번호 최대글자수 : [20자]	대표 연락처
secondary_contact 전화번호 최대글자수 : [20자]	보조 연락처
zipcode 최소글자수 : [2자] 최대글자수 : [14자]	우편번호
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소

Request Copy

Response Copy

Delete a shipping origin

DELETE /api/v2/admin/shippingorigins/{origin_code}

DELETE

등록된 출고지를 삭제할 수 있습니다.
기본출고지, 상품/품목이 할당된 출고지는 삭제할 수 없습니다.

기본스펙

Property	Description
SCOPE	배송 쓰기권한 (mall.write_shipping)
호출건수 제한	40

요청사양

Parameter	Description
origin_code Required 형식 : [A-Z0-9] 글자수 최소: [8자]~최대: [8자]	출고지 코드

Request Copy

Response Copy

Financials dailysales

일별 매출(Financials dailysales)은 PG사별, 일별 매출 정보를 제공합니다.
검색 조건에 부합하는 매출 정보 검색이 가능합니다.

Endpoints

GET /api/v2/admin/financials/dailysales

Financials dailysales properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
date	날짜
payment_amount	결제 금액
refund_amount	환불 금액
sales_count	판매건수

Retrieve a list of daily sales

GET /api/v2/admin/financials/dailysales

GET

검색 시작일과 종료일, PG사 정보를 이용하여 매출 정보를 조회합니다.
결제 금액, 환불 금액 등을 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	매출통계 읽기권한 (mall.read_salesreport)
호출건수 제한	1

요청사양

Parameter	Description
start_date Required	검색 시작일
end_date Required	검색 종료일
payment_gateway_name	PG 이름
partner_id	PG사 발급 가맹점 ID
payment_method	결제수단 코드 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 point : 선불금 cell : 휴대폰

Request Copy

Response Copy

Financials monthlysales

월별 매출(Financials monthlysales)은 PG사별, 월별 매출 정보를 제공합니다.
검색 조건에 부합하는 매출 정보 검색이 가능합니다.

Endpoints

GET /api/v2/admin/financials/monthlysales

Financials monthlysales properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
month	년월
payment_amount	결제 금액
refund_amount	환불 금액
sales_count	판매건수

Retrieve a list of monthly sales

GET /api/v2/admin/financials/monthlysales

GET

검색 시작월과 종료월, PG사 정보를 이용하여, 매출 정보를 조회합니다.
결제 금액, 환불 금액 등을 확인할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	매출통계 읽기권한 (mall.read_salesreport)
호출건수 제한	1

요청사양

Parameter	Description
start_month Required	검색 시작월
end_month Required	검색 종료월
payment_gateway_name	PG 이름
partner_id	PG사 발급 가맹점 ID
payment_method	결제수단 코드 card : 신용카드 tcash : 계좌이체 icash : 가상계좌 point : 선불금 cell : 휴대폰

Request Copy

Response Copy

Reports hourlysales

시간단위 정산통계(Reports hourlysales)는 특정 날짜와 시간을 기준으로 각종 매출에 관한 데이터를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/reports/hourlysales

Reports hourlysales properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
collection_date	정산 수집 일자
collection_hour	정산 수집 시간
order_count	주문수
item_count	품목수
order_price_amount	상품 구매금액
order_sale_price	할인금액
shipping_fee	배송비
coupon_discount_price	쿠폰 할인금액
actual_order_amount	실결제금액
refund_amount	환불 금액
sales	순매출
used_points	적립금
used_credits	예치금
used_naver_points	네이버 마일리지
used_naver_cash	네이버캐시
refund_points	환불 적립금
refund_credits	환불 예치금
refund_naver_points	환불 네이버 마일리지
refund_naver_cash	환불 네이버캐시

Retrieve hourly sales statistics of a store

GET /api/v2/admin/reports/hourlysales

GET

특정 날짜와 시간을 기준으로 각종 매출에 관한 데이터를 목록으로 조회할 수 있습니다.
주문수, 품목수, 구매금액, 할인금액 등을 조회할 수 있습니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	매출통계 읽기권한 (mall.read_salesreport)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
collection_hour	정산 수집 시간 수집 시간을 특정하여 검색 00 ~ 23 까지의 값을 입력할 수 있다.
limit 최소: [1]~최대: [1000]	조회결과 최대건수 DEFAULT 744
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Reports productsales

상품판매통계(Reports productsales)를 활용하여 상품을 기준으로 판매된 통계를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/reports/productsales

Reports productsales properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
collection_date	정산 수집 일자
collection_hour	정산 수집 시간
product_no	상품번호
variants_code	품목코드
product_price	상품 구매금액
settle_count	결제완료 수량
refund_count	환불완료 수량
sale_count	판매완료 수량
return_product_count	반품완료 수량
exchange_product_count	교환완료 수량
cancel_product_count	취소완료 수량
total_sale_count	누적 판매 수량
total_cancel_count	누적 취소 수량

Retrieve hourly product sales statistics of a store

GET /api/v2/admin/reports/productsales

GET

상품을 기준으로 판매통계를 조회할 수 있습니다.
품목코드, 결제완료 수량, 환불완료 수량, 누적판매 수량 등을 조회할 수 있습니다.
특정 기간과 시간을 기준으로도 조회가 가능합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	매출통계 읽기권한 (mall.read_salesreport)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
collection_hour	정산 수집 시간 수집 시간을 특정하여 검색 00 ~ 23 까지의 값을 입력할 수 있다.
limit 최소: [1]~최대: [1000]	조회결과 최대건수 DEFAULT 100
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Reports salesvolume

판매수량 통계(Reports salesvolume)는 쇼핑몰의 상품이 판매된 수량의 통계에 대한 기능입니다.
판매수량은 주기적으로 집계하여 업데이트 되므로 실시간의 데이터는 아닌 점 참고 부탁 드립니다.

Endpoints

GET /api/v2/admin/reports/salesvolume

Reports salesvolume properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
collection_date	정산 수집 일자 판매량 통계가 수집된 수집 날짜
collection_hour	정산 수집 시간 판매량 통계가 수집된 수집 시간
product_price	상품 판매가 해당 상품의 가격
product_option_price	상품 옵션 가격 해당 품목의 옵션 추가 가격.
settle_count	결제완료 수량 조회 기간동안 해당 품목이 결제 완료된 수량
exchane_product_count	교환완료 수량 조회 기간동안 해당 품목이 교환된 수량
cancel_product_count	취소완료 수량 조회 기간동안 해당 품목이 취소된 수량
return_product_count	반품완료 수량 조회 기간동안 해당 품목이 반품된 수량
updated_date	최종 데이터 갱신 시간 판매 수량 통계 데이터가 갱신된 시간 표시
variants_code	품목코드 해당 품목의 품목 코드
product_no	상품번호
total_sales	총 판매 건수 해당 품목이 검색한 기간 동안 총 판매된 수량

Retrieve a sales report

GET /api/v2/admin/reports/salesvolume

GET

판매수량 통계를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	매출통계 읽기권한 (mall.read_salesreport)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
product_no	상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. 조회시 상품번호(product_no)와 품목코드(variant_code) 둘 중에 하나는 반드시 포함하여야한다. ,(콤마)로 여러 건을 검색할 수 있다.
variants_code	품목코드 판매 수량을 검색할 품목 코드 조회시 상품번호(product_no)와 품목코드(variant_code) 둘 중에 하나는 반드시 포함하여야한다.
category_no	분류 번호 판매 수량 중 특정 카테고리에서 판매된 수량 조회
mobile	모바일 PC 여부 판매 수량 중 모바일 웹에서 판매된 수량 조회 T : 모바일 F : 그외
delivery_type	배송 유형 판매 수량 중 국내 또는 해외 배송 수량 조회 A : 국내 B : 해외
group_no	회원 등급 번호
supplier_id 최대글자수 : [20자]	공급사 아이디 판매 수량 중 특정 공급사 ID로 등록된 수량 조회
start_date Required 날짜	검색 시작일 판매 수량을 조회할 검색 시작일(결제일 기준) 검색 종료일과 같이 사용해야함.
end_date Required 날짜	검색 종료일 판매 수량을 조회할 검색 종료일(결제일 기준) 검색 시작일과 같이 사용해야함.

Request Copy

Response Copy

Carts

장바구니(Carts)는 상품을 주문하기 전 한번에 주문할 수 있도록 상품을 미리 담아두는 기능입니다.
장바구니 리소스에서는 Front API를 사용하여 특정 상품을 장바구니에 담을 수 있고 Admin API에서는 특정 회원의 장바구니를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/carts

Carts properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
basket_product_no	장바구니 상품번호
member_id	회원아이디
created_date	담은일자
product_no	상품번호
additional_option_values	추가입력 옵션
variant_code 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	상품 품목 코드
quantity	수량
product_price	상품 판매가
option_price	옵션 추가 가격
product_bundle	세트상품 여부 T : 세트상품 F : 세트상품 아님
shipping_type	배송 유형 A : 국내 B : 해외
category_no	분류 번호

Retrieve a shopping cart

GET /api/v2/admin/carts

GET

회원 장바구니에 담긴 상품을 조회할 수 있습니다.
한번에 여러 회원의 장바구니를 조회할 수 있습니다.
회원아이디, 담은일자, 상품번호 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
member_id Required	회원아이디 ,(콤마)로 여러 건을 검색할 수 있다.
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Customers wishlist

회원 관심상품(Customers wishlist)은 회원의 관심상품을 조회할 수 있는 관계형 리소스입니다.

Endpoints

GET /api/v2/admin/customers/{member_id}/wishlist/count
GET /api/v2/admin/customers/{member_id}/wishlist

Customers wishlist properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
wishlist_no	관심상품번호
product_no	상품번호
variant_code 형식 : [A-Z0-9] 글자수 최소: [12자]~최대: [12자]	품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음.
additional_option	추가입력 옵션
attached_file_option	파일 첨부 옵션
price	상품 판매가 상품의 판매 가격. 쿠폰 및 혜택을 적용하기 전의 가격. 상품 등록시엔 모든 멀티 쇼핑몰에 동일한 가격으로 등록하며, 멀티쇼핑몰별로 다른 가격을 입력하고자 할 경우 상품 수정을 통해 가격을 다르게 입력할 수 있다. ※ 판매가 = [ 공급가 + (공급가 * 마진율) + 추가금액 ]
product_bundle	세트상품 여부
created_date	담은일자 관심상품을 담은 일자
price_content 최대글자수 : [20자]	판매가 대체문구

Retrieve a count of products in customer wishlist

GET /api/v2/admin/customers/{member_id}/wishlist/count

GET

특정 회원이 관심상품으로 등록한 상품 갯수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter

Description

member_id
Required

회원아이디

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Retrieve a list of products in customer wishlist

GET /api/v2/admin/customers/{member_id}/wishlist

GET

특정 회원이 관심상품으로 등록한 상품을 목록으로 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter

Description

member_id
Required

회원아이디

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Products carts

상품 장바구니(Products carts)는 특정 상품을 장바구니에 담은 회원과 그 숫자를 조회할 수 있는 리소스입니다.
특정 상품을 장바구니에 담은 회원의 ID, 담은날짜와 회원의 수 정보를 조회할 수 있습니다.

Endpoints

GET /api/v2/admin/products/{product_no}/carts/count
GET /api/v2/admin/products/{product_no}/carts

Products carts properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
member_id	회원아이디
created_date	담은일자
product_no	상품번호
variant_code	상품 품목 코드
quantity	수량
product_bundle	세트상품 여부 T : 세트상품 F : 세트상품 아님

Retrieve a count of carts containing a product

GET /api/v2/admin/products/{product_no}/carts/count

GET

특정 상품을 장바구니에 담은 회원의 수를 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

product_no
Required

상품번호

시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다.

Request Copy

Response Copy

Retrieve a list of carts containing a product

GET /api/v2/admin/products/{product_no}/carts

GET

특정 상품을 장바구니에 담은 정보를 목록으로 확인합니다.
회원아이디, 담은일자 등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인화정보 읽기권한 (mall.read_personal)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Customersprivacy

회원 개인정보(Customersprivacy)는 특정 회원의 개인정보에 대한 리소스입니다.
민감한 개인정보가 포함되어 있으므로 사용에 주의를 기울여야 합니다.

Endpoints

GET /api/v2/admin/customersprivacy
GET /api/v2/admin/customersprivacy/count
GET /api/v2/admin/customersprivacy/{member_id}
PUT /api/v2/admin/customersprivacy/{member_id}

Customersprivacy properties

Attribute	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
member_id 최대글자수 : [20자]	회원아이디
name	이름 해당 회원의 이름
name_english	영문이름 해당 회원의 영문 이름
name_phonetic	발음표기 이름 (일본어) 해당 회원의 발음 표기 이름(일본어)
phone	전화번호 해당 회원의 일반전화
cellphone	휴대전화 해당 회원의 휴대전화
email	이메일 해당 회원의 이메일
sms	SMS 수신여부 SMS를 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. T : 수신 F : 수신안함
news_mail	뉴스메일 수신여부 이메일을 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. T : 수신 F : 수신안함
thirdparty_agree	제3자 제공 동의 여부 T : 동의함 F : 동의안함
wedding_anniversary 날짜	결혼기념일 해당 회원의 결혼기념일
birthday 날짜	생일 해당 회원의 생일
solar_calendar	양력여부 생일이 양력인지 음력인지 여부 T : 양력 F : 음력
total_points	총 적립금
available_points	가용 적립금
used_points	사용 적립금
city 최대글자수 : [255자]	시/군/도시
state 최대글자수 : [255자]	주/도
address1 최대글자수 : [255자]	기본 주소 해당 회원의 기본주소(시/군/도)
address2 최대글자수 : [255자]	상세 주소 해당 회원의 상세주소
group_no	회원등급번호 해당 회원의 회원등급의 번호
job_class	직종 해당 회원의 직종
job	직업 해당 회원의 직업
zipcode 최대글자수 : [14자]	우편번호
created_date	가입일 해당 회원의 가입일시
member_authentication	회원인증여부 회원 인증여부. 인증에 따라 회원은 4종류로 구분된다. 인증회원을 특별관리회원으로 설정할 경우 해당 회원은 가장 마지막에 설정한 특별관리회원으로 표시된다. T : 인증 F : 미인증 B : 특별관리회원 J : 14세미만회원
use_blacklist	불량회원설정 불량회원 여부. 불량회원일 경우 불량회원 타입에 따라 상품구매 차단, 로그인 차단, 로그인과 상품구매 모두를 차단할 수 있음. T : 설정함 F : 설정안함
blacklist_type	불량회원 차단설정 해당 회원의 불량회원 타입. 불량회원 타입에 따라 상품구매 차단, 로그인 차단, 로그인과 상품구매 모두를 차단할 수 있음. P : 상품구매차단 L : 로그인차단 A : 로그인&상품구매 차단
last_login_date	최근 접속일시 해당 회원의 최종 로그인 일시
member_authority	회원권한구분 회원 권한 구분. 회원 권한은 일반회원, 대표운영자, 부운영자, 공급사로 권한이 구분됨. C : 일반회원 P : 대표 운영자 A : 부운영자 S : 공급사
nick_name 최대글자수 : [50자]	운영자 별명 해당 회원의 별명
recommend_id	추천인아이디 해당 회원의 가입당시 입력한 추천인 아이디
residence	지역코드 해당 회원의 주거지역
interest	관심분야 해당 회원의 관심사
gender	성별 해당 회원의 성별 M : 남자 F : 여자
member_type	회원타입 해당 회원의 회원 타입 p : 개인 c : 사업자 f : 외국인
company_type	사업자 구분 해당 회원의 회원타입이 사업자일경우 p : 개인사업자 c : 법인사업자
foreigner_type	외국인 인증방법 해당 외국인 회원의 인증방법 f : 외국인등록번호 p : 여권번호 d : 국제운전면허증
authentication_method	인증 수단 null : 인증안함 i : 아이핀인증 m : 휴대폰 본인인증 e : 이메일인증 d : 휴대폰 인증(중복 확인) a : 앱 인증(기타 인증)
lifetime_member	평생회원 동의여부 T : 동의함 F : 동의안함
corporate_name	법인명 해당 회원의 법인명
nationality	국적 해당 회원이 "외국인 회원"일 경우, 해당 회원의 국적
shop_name	쇼핑몰명 해당 회원의 상호명
country_code	국가코드 해당 회원이 가입시 입력한 국가
use_mobile_app	모바일앱 사용여부 해당 회원의 모바일앱 사용여부 T : 사용 F : 사용안함
join_path	가입경로 P : PC M : 모바일
fixed_group	회원등급 고정 여부 특정 회원이 회원자동등급변경에 적용되지 않기 위한 등급 고정 여부 회원자동등급변경 기능을 사용하는 몰에서만 사용 가능하다. T : 고정함 F : 고정안함
refund_bank_code 최대글자수 : [20자]	환불 은행 코드
refund_bank_account_no 최대글자수 : [40자]	환불 계좌번호
refund_bank_account_holder	환불계좌 예금주 명의
company_condition 최대글자수 : [50자]	업태
company_line 최대글자수 : [50자]	종목
sns_list	연동중인 SNS
account_reactivation_date	휴면회원 해제일
available_credits	가용 예치금
additional_information	추가항목 해당 회원의 추가항목

Retrieve a list of customer information

GET /api/v2/admin/customersprivacy

GET

쇼핑몰에 가입한 회원들을 목록으로 조회합니다.
회원아이디, 이름, 휴대전화 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인정보 읽기권한 (mall.read_privacy)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
search_type	검색 타입 회원 검색을 회원정보 기반으로 할지 가입일 기준으로 할지 선택하여 검색할 수 있다. 가입일 기준으로 검색할 경우 offset과 관계 없이 전체 회원을 검색할 수 있다. ※ 가입일 기준 사용시 created_start_date 외의 모든 검색 조건은 사용할 수 없다. customer_info : 회원정보 기반 검색 created_date : 가입일 기준 검색 DEFAULT customer_info
created_start_date 날짜	가입일 기준 검색시 검색 시작일 search_type이 created_date 일 경우 가입일 기준의 검색 시작일. 해당 가입일 이후에 가입한 회원을 검색할 수 있다.
member_id 최대글자수 : [20자]	회원아이디
news_mail	뉴스메일 수신여부 이메일을 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. T : 수신 F : 수신안함
sms	SMS 수신여부 SMS를 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. T : 수신 F : 수신안함
thirdparty_agree	제3자 제공 동의 여부 T : 동의함 F : 동의안함
group_no	회원등급번호 해당 회원의 회원등급의 번호
search_field	검색필드 조회하고자 하는 회원의 검색필드. id : 아이디 name : 이름 hp : 핸드폰 tel : 전화번호 mail : 이메일 shop_name : 상호명
keyword	검색어 조회하고자 하는 회원의 검색필드에 대한 검색어를 입력함. ex) search_field : mail keyword : cafe24@cafe24.com ,(콤마)로 여러 건을 검색할 수 있다.
date_type	검색날짜 유형 조회의 기준이 되는 검색필드. '회원가입일' 기준으로 검색할 경우 검색시작일과 검색종료일의 기간은 회원가입일 기준이 됨. join : 회원가입일 login : 최근접속일 age : 생년월일 account_reactivation : 휴면해제일
start_date 날짜	검색 시작일 특정 조회기준에 대한 검색 시작일. 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색함. ex) 2018-12-31 00:00:00
end_date 날짜	검색 종료일 특정 조회기준에 대한 검색 종료일. 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색함. ex) 2018-12-31 23:59:59
member_type	회원타입 해당 회원의 회원 타입 vip : 특별관리회원 poor : 블랙리스트 pointfy : 통합멤버쉽 사용자
member_class	회원구분 EC 일본, 베트남 버전에서는 사용할 수 없음. p : 개인 c : 사업자 f : 외국인
residence	지역코드 해당 회원의 주거지역 ,(콤마)로 여러 건을 검색할 수 있다.
gender	성별 해당 회원의 성별 M : 남자 F : 여자
member_authority	회원권한구분 회원 권한 구분. 회원 권한은 일반회원, 대표운영자, 부운영자, 공급사로 권한이 구분됨. C : 일반회원 P : 대표 운영자 A : 부운영자 S : 공급사 DEFAULT C
join_path	가입경로 P : PC M : 모바일
use_mobile_app	모바일앱 사용여부 T : 사용 F : 사용안함
fixed_group	회원등급 고정 여부 T : 고정함 F : 고정안함
limit 최소: [1]~최대: [1000]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 30
offset 최대값: [8000]	조회결과 시작위치 search_type이 created_date 일 경우 creted_start_date를 증가시키면서 전체 회원을 검색할 수 있으므로 offset은 사용할 수 없다. DEFAULT 0

Request Copy

Response Copy

Retrieve a count of customer information

GET /api/v2/admin/customersprivacy/count

GET

쇼핑몰에 가입한 회원들의 수를 조회합니다.

기본스펙

Property	Description
SCOPE	개인정보 읽기권한 (mall.read_privacy)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
search_type	검색 타입 회원 검색을 회원정보 기반으로 할지 가입일 기준으로 할지 선택하여 검색할 수 있다. 가입일 기준으로 검색할 경우 offset과 관계 없이 전체 회원을 검색할 수 있다. ※ 가입일 기준 사용시 created_start_date 외의 모든 검색 조건은 사용할 수 없다. customer_info : 회원정보 기반 검색 created_date : 가입일 기준 검색 DEFAULT customer_info
created_start_date 날짜	가입일 기준 검색시 검색 시작일 search_type이 created_date 일 경우 가입일 기준의 검색 시작일. 해당 가입일 이후에 가입한 회원을 검색할 수 있다.
member_id 최대글자수 : [20자]	회원아이디
news_mail	뉴스메일 수신여부 이메일을 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. T : 수신 F : 수신안함
sms	SMS 수신여부 이벤트 SMS를 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. T : 수신 F : 수신안함
thirdparty_agree	제3자 제공 동의 여부 T : 동의함 F : 동의안함
group_no	회원등급번호 해당 회원의 회원등급의 번호
search_field	검색필드 조회하고자 하는 회원의 검색필드. id : 아이디 name : 이름 hp : 핸드폰 tel : 전화번호 mail : 이메일 shop_name : 상호명
keyword	검색어 ,(콤마)로 여러 건을 검색할 수 있다.
date_type	검색날짜 유형 join : 회원가입일 login : 최근접속일 age : 생년월일 account_reactivation : 휴면해제일
start_date 날짜	검색 시작일 특정 조회기준에 대한 검색 시작일. 검색 종료일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색함. ex) 2018-12-31 00:00:00
end_date 날짜	검색 종료일 특정 조회기준에 대한 검색 종료일. 검색 시작일과 같이 사용해야함. 검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색함. ex) 2018-12-31 23:59:59
member_type	회원타입 해당 회원의 회원 타입 vip : 특별관리회원 poor : 블랙리스트 pointfy : 통합멤버쉽 사용자
member_class	회원구분 EC 일본, 베트남 버전에서는 사용할 수 없음. p : 개인 c : 사업자 f : 외국인
residence	지역코드 해당 회원의 주거지역 (,(콤마)로 여러 건을 검색할 수 있다.)누락 ,(콤마)로 여러 건을 검색할 수 있다.
gender	성별 해당 회원의 성별 M : 남자 F : 여자
member_authority	회원권한구분 회원 권한 구분. 회원 권한은 일반회원, 대표운영자, 부운영자, 공급사로 권한이 구분됨. C : 일반회원 P : 대표 운영자 A : 부운영자 S : 공급사 DEFAULT C
join_path	가입경로 P : PC M : 모바일
use_mobile_app	모바일앱 사용여부 T : 사용 F : 사용안함
fixed_group	회원등급 고정 여부 T : 고정함 F : 고정안함

Request Copy

Response Copy

Retrieve a customer information

GET /api/v2/admin/customersprivacy/{member_id}

GET

회원아이디를 이용하여 회원을 조회합니다.
이름, 영문이름, 휴대전화번호, 이메일 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인정보 읽기권한 (mall.read_privacy)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

멀티쇼핑몰 번호

멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.

DEFAULT 1

member_id
Required

최대글자수 : [20자]

회원아이디

Request Copy

Response Copy

Update a customer information

PUT /api/v2/admin/customersprivacy/{member_id}

PUT

회원아이디를 이용하여 회원정보를 수정합니다.
SMS 수신여부, 생일, 주소 등을 변경합니다.

기본스펙

Property	Description
SCOPE	개인정보 쓰기권한 (mall.write_privacy)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
member_id Required 최대글자수 : [20자]	회원아이디
cellphone	휴대전화
email 이메일	이메일
sms	SMS 수신여부 T : 수신 F : 수신안함
news_mail	뉴스메일 수신여부 T : 수신 F : 수신안함
thirdparty_agree	제3자 제공 동의 여부 T : 동의함 F : 동의안함
birthday	생일
solar_calendar	양력여부 T : 양력 F : 음력
address1 최대글자수 : [255자]	기본 주소
address2 최대글자수 : [255자]	상세 주소
zipcode 최대글자수 : [14자]	우편번호
country_code	국가코드
additional_information	추가항목
key 추가항목 키 value 추가항목 값
city 최대글자수 : [255자]	시/군/도시
state 최대글자수 : [255자]	주/도
refund_bank_code 최대글자수 : [20자]	환불 은행 코드
refund_bank_account_no 최대글자수 : [40자]	환불 계좌번호
refund_bank_account_holder	환불계좌 예금주 명의
fixed_group	회원등급 고정 여부 T : 고정함 F : 고정안함

Request Copy

Response Copy

Products wishlist customers

상품을 관심상품으로 담은 회원(Products wishlist customers)은 상품을 관심상품으로 담은 회원을 조회할 수 있는 리소스입니다.

Endpoints

GET /api/v2/admin/products/{product_no}/wishlist/customers
GET /api/v2/admin/products/{product_no}/wishlist/customers/count

Products wishlist customers properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
member_id	회원아이디

Retrieve a list of customers with a product in wishlist

GET /api/v2/admin/products/{product_no}/wishlist/customers

GET

특정 상품을 관심상품에 담은 회원의 목록을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인정보 읽기권한 (mall.read_privacy)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음.

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Retrieve a count of customers with a product in wishlist

GET /api/v2/admin/products/{product_no}/wishlist/customers/count

GET

특정 상품을 관심상품에 담은 회원 수를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	개인정보 읽기권한 (mall.read_privacy)
호출건수 제한	40

요청사양

Parameter

Description

product_no
Required

상품번호

shop_no

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Credits

예치금(Credits)는 주문 환불시 환불수단으로서 받을 수 있는 현금성 자산입니다.
별도의 Scope를 가지고 있으며 매우 민감한 API 이므로 이용에 주의를 기울여야 합니다.

Endpoints

GET /api/v2/admin/credits

Credits properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
issue_date	등록일
member_id 최대글자수 : [20자]	회원아이디
group_name	회원등급명
increase_amount	지급 금액
decrease_amount	차감 금액
balance	잔액
admin_id	관리자 아이디
admin_name	관리자 이름
reason	처리사유
case	예치금 유형
order_id	주문번호

Retrieve a list of credits by date range

GET /api/v2/admin/credits

GET

예치금을 목록으로 조회합니다.
회원아이디, 지금 금액, 예치금 유형등을 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	적립금 읽기권한 (mall.read_mileage)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
type	예치금 증가/차감 여부 I : 지급내역 D : 차감내역
case	예치금 유형 A : 주문취소 B : 예치금환불 C : 상품구매 D : 임의조정 E : 현금환불 G : 충전
admin_id	관리자 아이디
order_id 주문번호	주문번호
search_field	검색필드 id : 아이디 reason : 처리사유
keyword	검색어
limit 최소: [1]~최대: [200]	조회결과 최대건수 DEFAULT 50
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Credits report

예치금 통계(Credit report)는 지정한 기간동안의 예치금 통계를 조회할 수 있는 리소스입니다.

Endpoints

GET /api/v2/admin/credits/report

Credits report properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
increase_amount	지급 금액
decrease_amount	차감 금액
credits_total	예치금 합계

Retrieve a credit report by date range

GET /api/v2/admin/credits/report

GET

예치금 통계를 조회합니다.
지급 금액, 차감 금액, 예치금 합계를 확인할 수 있습니다.

기본스펙

Property	Description
SCOPE	적립금 읽기권한 (mall.read_mileage)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
type	예치금 증가/차감 여부 I : 지급내역 D : 차감내역
case	예치금 유형 A : 주문취소 B : 예치금환불 C : 상품구매 D : 임의조정 E : 현금환불 G : 충전
admin_id	관리자 아이디
search_field	검색필드 id : 아이디 reason : 처리사유
keyword	검색어

Request Copy

Response Copy

Points

적립금(Points)은 쇼핑몰 회원의 적립금의 조회, 증가, 차감을 할 수 있는 기능입니다.
적립금은 매우 민감한 기능이므로 이용에 주의를 기울여야 합니다.

Endpoints

GET /api/v2/admin/points
POST /api/v2/admin/points

Points properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
case	적립금 타입
member_id	회원아이디
email	이메일
group_name	회원등급명
available_points_increase	적립금 증가
available_points_decrease	적립금 차감
available_points_total	가용 적립금
unavailable_points	미가용 적립금
order_date	주문일
issue_date	적립금 지급일
available_date	미가용 적립금 사용 가능일
admin_id	관리자 아이디
admin_name	관리자 이름
order_id	주문번호
reason	적립 사유 적립금을 증가/차감하는 사유를 입력할 수 있다.
amount	적립금 증감액 1회당 최대 1,000,000원 이하까지 적립금을 지급할 수 있음. 가용 적립금보다 큰 금액을 차감할 수 없다.
type	적립금 증가/차감 여부 적립금을 증가시킬지 차감시킬지 여부를 선택할 수 있다.

Retrieve points

GET /api/v2/admin/points

GET

회원의 적립금을 조회할 수 있습니다.
지급 또는 차감된 적립금 각각에 대하여 타입과 사유 등을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	적립금 읽기권한 (mall.read_mileage)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
member_id 최대글자수 : [20자]	회원아이디
email 이메일	이메일
order_id 최대글자수 : [100자]	주문아이디
group_no	회원등급번호
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일
case	적립금 타입 적립금 타입 지정 없이 전체 조회시에는 D: 적립금 환불 타입은 제외되고 조회 되므로, 적립금 환불 타입을 조회하려면 타입을 지정해야 합니다. A : 관리자 직접 적립금 부여 B : 주문취소로 인한 환불시 환불금을 적립금으로 부여 C : 적립대기중이던 적립금 취소 D : 반품완료 후 사용가능 E : csv파일로 등록된 회원 F : 주문취소로 인해 상품에 대한 적립금 차감 G : 추천한 신규 가입자에게 적립금 부여 H : (기존 적립금 내역용 레거시 타입) 주문시 회원등급에 따른 적립금 부여(회원 등급 적립금) I : 주문취소로 인해 회원등급에 대한 적립금 환불 J : 주문취소로 인해 쿠폰에 대한 적립금 환불 K : 주문시 회원등급에 따른 적립금 부여(회원 등급 적립금) L : 주문시 사용한 쿠폰에 따른 적립금 부여(쿠폰 적립금) M : 상품구매시 사용한 적립금 N : 신규가입시 적립금 부여 O : 적립금 즉시지급 쿠폰(온라인/시리얼) P : 주문시 구매한 상품에 대한 적립금 부여(구매에 대한 적립금) Q : 즐겨찾기 적립금 R : 추천받은 기존 가입자에게 적립금 부여 S : 주문취소시 구매에 사용한 적립금 부여(적립금 복원(주문취소)) T : 뉴스레터 동의 적립금 U : 바로가기(링콘) 설치 후 로그인 V : 피추천인 주문취소에 따른 감사적립금 차감 W : 피추천인 주문에 따른 감사적립금 부여 X : 바로가기(링콘) 접속 후 구매에 따른 추가 적립금 부여 Y : (기존 적립금 내역용 레거시 타입) 주문시 구매한 상품에 대한 적립금 부여(구매에 대한 적립금) Z : 바로가기 아이콘 설치 AA : 바로가기(링콘) 접속 후 구매에 따른 추가 적립금 차감 AB : 적립금 소멸 AD : 회원정보 이벤트 참여 적립금 AE : 플러스앱 주문 적립금 AF : 주문취소에 의한 플러스앱주문 적립금 차감 AG : 오프라인구매-적립금 사용 AH : 오프라인취소-구매시 사용한 적립금 복원 AI : 이벤트팩토리 적립금 AK : 플러스앱 푸시알림 ON 적립금 AL : 플러스앱 설치 적립금 AM : API 를 통한 적립금 AN : 플러스앱 푸시 혜택받기로 인한 적립금 AO : 구매 확정 취소에 의한 플러스앱 적립금 차감 AP : 구매 확정 취소에 의한 쿠폰 적립금 차감 AQ : 구매 확정 취소에 의한 회원등급 적립금 차감 AR : 구매 확정 취소에 의한 상품 적립금 차감 AS : 구매 확정 취소에 의한 링콘 적립금 차감 1 : SMS 수신동의 + 이메일 수신동의 적립금 2 : SMS 수신동의 적립금 3 : 회원 정보 수정 이벤트 4 : 오프라인취소-구매시 지급한 적립금 회수 5 : 오프라인구매-적립금 지급 6 : [품목추가] 관리자 직접 지급 [상품] 적립금 7 : [품목추가] 관리자 직접 지급 [회원] 적립금 8 : [품목교환] 관리자 직접 지급 [상품] 적립금 9 : [품목교환] 관리자 직접 지급 [회원] 적립금
points_category	적립금 내역 available: 가용적립금 unavailable: 미가용 적립금 unavailable_coupon: 미가용회원/쿠폰적립금 DEFAULT available
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Issue and deduct points

POST /api/v2/admin/points

POST

회원의 적립금의 증가, 차감 처리를 할 수 있습니다.

기본스펙

Property	Description
SCOPE	적립금 쓰기권한 (mall.write_mileage)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. SMS는 한국어 멀티쇼핑몰에서만 발송 가능하다. DEFAULT 1
member_id Required 최대글자수 : [20자]	회원아이디 회원 아이디
order_id 주문번호	주문번호
amount Required 최소값: [0]	적립금 증감액 1회당 최대 1,000,000원 이하까지 적립금을 지급할 수 있음. 가용 적립금보다 큰 금액을 차감할 수 없다.
type Required	적립금 증가/차감 여부 적립금을 증가시킬지 차감시킬지 여부를 선택할 수 있다. increase : 증가 decrease : 차감
reason	적립 사유 적립금을 증가/차감하는 사유를 입력할 수 있다.

Request Copy

Response Copy

Points autoexpiration

포인트 자동만료(Points autoexpiration)는 포인트를 자동으로 만료시키는 것과 관련된 기능입니다.
자동만료 설정을 조회하거나 등록 및 삭제가 가능합니다.

Endpoints

GET /api/v2/admin/points/autoexpiration
POST /api/v2/admin/points/autoexpiration
DELETE /api/v2/admin/points/autoexpiration

Points autoexpiration properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
expiration_date	최초 소멸 시행일
interval_month	소멸 실행 주기 1: 1개월 3: 3개월 6: 6개월 12: 1년
target_period_month	소멸 대상 적립금 6: 소멸일 기준 6개월 이전 적립금 12: 소멸일 기준 1년 이전 적립금 18: 소멸일 기준 1년 6개월 이전 적립금 24: 소멸일 기준 2년 이전 적립금 30: 소멸일 기준 2년 6개월 이전 적립금 36: 소멸일 기준 3년 이전 적립금
group_no	소멸 대상 회원등급 0: 전체 회원
standard_point	소멸 대상 기준 금액
send_email	이메일 발송 T: 설정함 F: 설정안함
send_sms	SMS 발송 T: 설정함 F: 설정안함
notification_time_day	알람시기 선택 3: 3일 전 발송 7: 7일 전 발송 15: 15일 전 발송 30: 1개월 전 발송

Retrieve an automatic points expiration

GET /api/v2/admin/points/autoexpiration

GET

쇼핑몰의 적립금 자동만료 설정을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	적립금 읽기권한 (mall.read_mileage)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Create an automatic points expiration

POST /api/v2/admin/points/autoexpiration

POST

쇼핑몰의 포인트 자동만료 설정을 등록할 수 있습니다.
적립금의 최초 소멸 시행일과 소멸 실행 주기 등을 설정할 수 있습니다.

기본스펙

Property	Description
SCOPE	적립금 쓰기권한 (mall.write_mileage)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
expiration_date Required 날짜	최초 소멸 시행일
interval_month Required	소멸 실행 주기 1: 1개월 3: 3개월 6: 6개월 12: 1년
target_period_month Required	소멸 대상 적립금 6: 소멸일 기준 6개월 이전 적립금 12: 소멸일 기준 1년 이전 적립금 18: 소멸일 기준 1년 6개월 이전 적립금 24: 소멸일 기준 2년 이전 적립금 30: 소멸일 기준 2년 6개월 이전 적립금 36: 소멸일 기준 3년 이전 적립금
group_no	소멸 대상 회원등급 0: 전체 회원 DEFAULT 0
standard_point Required 최소값: [1]	소멸 대상 기준 금액 소멸할 적립금의 최소 기준 금액 입력 예) 100 기재 시, 100원 이상 적립금 보유 회원만 소멸 대상
send_email	이메일 발송 T: 설정함 F: 설정안함 DEFAULT F
send_sms	SMS 발송 T: 설정함 F: 설정안함 DEFAULT F
notification_time_day	알람시기 선택 3: 3일 전 발송 7: 7일 전 발송 15: 15일 전 발송 30: 1개월 전 발송

Request Copy

Response Copy

Delete an automatic points expiration

DELETE /api/v2/admin/points/autoexpiration

DELETE

쇼핑몰의 포인트 자동만료 설정을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	적립금 쓰기권한 (mall.write_mileage)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

Request Copy

Response Copy

Points report

적립금 통계(Points report)는 지정한 기간동안의 가용적립금의 증감 내역, 미가용 적립금의 총액 등 적립금과 관련된 통계를 조회할 수 있는 리소스입니다.

Endpoints

GET /api/v2/admin/points/report

Points report properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
available_points_increase	가용 적립금 증가
available_points_decrease	가용 적립금 차감
available_points_total	가용 적립금 전체
unavailable_points	미가용 적립금
unavailable_coupon_points	미가용 회원 쿠폰 적립금

Retrieve a points report by date range

GET /api/v2/admin/points/report

GET

특정 기간 동안의 적립금의 증감에 관한 통계를 조회할 수 있습니다.
가용 적립금의 증가, 차감, 전체를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	적립금 읽기권한 (mall.read_mileage)
호출건수 제한	40

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
member_id 최대글자수 : [20자]	회원아이디
email 이메일	이메일
group_no	회원등급번호
start_date Required 날짜	검색 시작일
end_date Required 날짜	검색 종료일

Request Copy

Response Copy

Customers invitation

회원 초대(invitation)는 계정을 활성화하기 위해 SMS, 이메일 등으로 초대 메시지를 발송하는 기능입니다.
기존에 가입되어 있는 아이디가 있어야만 초대가 가능합니다.

Endpoints

POST /api/v2/admin/customers/{member_id}/invitation

Customers invitation properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
member_id 최대글자수 : [16자]	회원아이디

Send an invitation to activate account

POST /api/v2/admin/customers/{member_id}/invitation

POST

SMS, 이메일 등으로 고객의 계정을 활성화하기 위한 초대 메시지를 발송합니다.
회원아이디, 계정 활성화 초대 수단을 필수로 입력합니다.

기본스펙

Property	Description
SCOPE	알림 쓰기권한 (mall.write_notification)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

member_id
Required

최대글자수 : [16자]

회원아이디

invitation_type
Required

계정 활성화 초대 수단

Request Copy

Response Copy

Push

Endpoints

GET /api/v2/admin/push
POST /api/v2/admin/push
PUT /api/v2/admin/push/{push_code}
DELETE /api/v2/admin/push/{push_code}

Push properties

Attribute	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호
push_code	푸시 코드
send_type	발송구분 immediately : 즉시발송 reservation : 예약발송 repetition : 반복발송
reserve_day	발송예약 일
reserve_hour	발송예약 시
reserve_minuate	발송예약 분
os_type	OS 타입 all : 전체 android : 안드로이드 ios : iOS
receiver_type	수신대상 타입 all : 앱사용자 group : 가입회원 id : 대상등록
group_no	수신대상 회원등급
title	푸시 제목
content_android	푸시 내용 (Android)
content_ios	푸시 내용 (iOS)
image_url	푸시 이미지 URL
use_link	푸시 연결 사용 여부 T : 사용함 F : 사용안함
link_type	푸시 연결 타입 url : 쇼핑몰페이지 coupon : 쿠폰 화면 notice : 푸시 알림함
external_link	푸시 외부 연결 URL
use_benefit	푸시 혜택 사용여부 T : 사용함 F : 사용안함
benefit_end_day	푸시 혜택 발송일 기준 종료일
benefit_points	푸시 혜택 적립금액
silent	사일런트 푸시 사용 여부 T : 사용함 F : 사용안함
repetition_no	푸시 반복발송 번호
created_date	등록일
send_date	발송일시
reserve_date	발송예정일시
send_status	발송상태 W : 대기 F : 실패 T : 성공 H : 중단 D : 실행중 X : 실패건재발송
send_count_android	발송건수 (Android)
send_count_ios	발송건수 (iOS)
response_count_android	응답건수 (Android)
response_count_ios	응답건수 (iOS)
member_id	수신대상 회원아이디

Retrieve push notification delivery history

GET /api/v2/admin/push

GET

기본스펙

Property	Description
SCOPE	알림 읽기권한 (mall.read_notification)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
search_status Required	푸시 현황조회 sending : 발송현황 reservation : 예약현황
search_date	검색 기준일 send_date : 발송일 regist_date : 등록일
start_date 날짜	검색 시작일
end_date 날짜	검색 종료일
push_code	푸시 코드 ,(콤마)로 여러 건을 검색할 수 있다.
content	푸시 내용
send_type	발송구분 immediately : 즉시발송 reservation : 예약발송 repetition : 반복발송
receiver_type	수신대상 타입 all : 앱사용자 group : 가입회원 id : 대상등록
silent	사일런트 푸시 사용 여부 T : 사용함 F : 사용안함
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10
offset 최대값: [10000]	조회결과 시작위치 DEFAULT 0

Request Copy

Response Copy

Create a push notification

POST /api/v2/admin/push

POST

기본스펙

Property	Description
SCOPE	알림 쓰기권한 (mall.write_notification)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
send_type Required	발송구분 immediately : 즉시발송 reservation : 예약발송
reserve_day	발송예약 일
reserve_hour 최소: [0]~최대: [23]	발송예약 시
reserve_minuate 최소: [0]~최대: [59]	발송예약 분
os_type	OS 타입 all : 전체 android : 안드로이드 ios : iOS DEFAULT all
receiver_type	수신대상 타입 all : 앱사용자 group : 가입회원 id : 대상등록 DEFAULT all
group_no 최소값: [1]	수신대상 회원등급
member_id 최대글자수 : [20자]	수신대상 회원아이디
title	푸시 제목
content_android	푸시 내용 (Android)
content_ios	푸시 내용 (iOS)
image_url	푸시 이미지 URL
use_link	푸시 연결 사용 여부 T : 사용함 F : 사용안함 DEFAULT F
link_type	푸시 연결 타입 url : 쇼핑몰페이지 coupon : 쿠폰 화면 notice : 푸시 알림함
external_link	푸시 외부 연결 URL
use_benefit	푸시 혜택 사용여부 T : 사용함 F : 사용안함 DEFAULT F
benefit_end_day 최소: [1]~최대: [999]	푸시 혜택 발송일 기준 종료일
benefit_points	푸시 혜택 적립금액
silent	사일런트 푸시 사용 여부 T : 사용함 F : 사용안함 DEFAULT F

Request Copy

Response Copy

Update a push notification

PUT /api/v2/admin/push/{push_code}

PUT

기본스펙

Property	Description
SCOPE	알림 쓰기권한 (mall.write_notification)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
push_code Required	푸시 코드
title	푸시 제목
content_android	푸시 내용 (Android)
content_ios	푸시 내용 (iOS)
image_url	푸시 이미지 URL

Request Copy

Response Copy

Delete a push notification

DELETE /api/v2/admin/push/{push_code}

DELETE

기본스펙

Property	Description
SCOPE	알림 쓰기권한 (mall.write_notification)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

push_code
Required

푸시 코드

Request Copy

Response Copy

Recipientgroups

발송 그룹(Recipientgroups)은 대량 메일 발송 그룹을 관리하는 기능입니다.
발송 그룹의 조회, 추가, 수정, 삭제가 가능합니다.

Endpoints

GET /api/v2/admin/recipientgroups
GET /api/v2/admin/recipientgroups/{group_no}
POST /api/v2/admin/recipientgroups
PUT /api/v2/admin/recipientgroups/{group_no}
DELETE /api/v2/admin/recipientgroups/{group_no}

Recipientgroups properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
group_no	발송그룹 번호
group_name 최대글자수 : [40자]	발송그룹명
group_description 최대글자수 : [255자]	발송그룹 설명
created_date	등록일
group_member_count	발송그룹 회원 수
news_mail	뉴스메일 수신여부 T : 수신허용 F : 수신안함 D : 절대수신안함
sms	SMS 수신여부 T : 수신 F : 수신안함
member_group_no	회원등급번호
member_class	회원구분 p : 개인 c : 사업자 f : 외국인
member_type	회원타입 vip : 특별관리회원 poor : 불량회원
join_path	가입경로 P : PC M : 모바일
inflow_path	유입경로
inflow_path_detail	유입경로 상세정보
date_type	검색날짜 유형 join : 회원가입일 birthday : 생일 wedding : 결혼기념일 partner : 배우자생일
start_date 날짜	검색 시작일
end_date 날짜	검색 종료일
solar_calendar	양력여부 T : 양력 F : 음력
age_min	나이 검색 최소값
age_max	나이 검색 최대값
gender	성별 M : 남자 F : 여자
available_points_min	적립금 검색 최소값
available_points_max	적립금 검색 최대값
use_mobile_app	모바일앱 사용여부 T : 사용 F : 사용안함
plusapp_member_join	플러스앱 경로 가입회원 여부 T : 사용함 F : 사용안함

Retrieve distribution group list

GET /api/v2/admin/recipientgroups

GET

대량 메일 발송 그룹의 목록을 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	알림 읽기권한 (mall.read_notification)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

limit

최소: [1]~최대: [100]

조회결과 최대건수

DEFAULT 10

offset

최대값: [10000]

조회결과 시작위치

DEFAULT 0

Request Copy

Response Copy

Retrieve distribution group details

GET /api/v2/admin/recipientgroups/{group_no}

GET

특정 대량 메일 발송 그룹의 상세 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	알림 읽기권한 (mall.read_notification)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

group_no
Required

최소값: [1]

발송그룹 번호

Request Copy

Response Copy

Create a distribution group

POST /api/v2/admin/recipientgroups

POST

대량 메일 발송 그룹을 생성할 수 있습니다.

기본스펙

Property	Description
SCOPE	알림 쓰기권한 (mall.write_notification)
호출건수 제한	30
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
group_name Required 최대글자수 : [40자]	발송그룹명
group_description 최대글자수 : [255자]	발송그룹 설명
news_mail	뉴스메일 수신여부 T : 수신허용 F : 수신안함 D : 절대수신안함
sms	SMS 수신여부 T : 수신 F : 수신안함
member_group_no 최소값: [1]	회원등급번호
member_class	회원구분 EC 일본, 베트남 버전에서는 사용할 수 없음. p : 개인 c : 사업자 f : 외국인
member_type	회원타입 vip : 특별관리회원 poor : 불량회원
join_path	가입경로 P : PC M : 모바일
inflow_path	유입경로
inflow_path_detail	유입경로 상세정보
date_type	검색날짜 유형 join : 회원가입일 birthday : 생일 wedding : 결혼기념일 partner : 배우자생일
start_date	검색 시작일
end_date	검색 종료일
solar_calendar	양력여부 T : 양력 F : 음력
age_min 최소: [1]~최대: [99]	나이 검색 최소값
age_max 최소: [1]~최대: [99]	나이 검색 최대값
gender	성별 M : 남자 F : 여자
available_points_min 최소: [0]~최대: [999999999]	적립금 검색 최소값
available_points_max 최소: [0]~최대: [999999999]	적립금 검색 최대값
use_mobile_app	모바일앱 사용여부 T : 사용 F : 사용안함
plusapp_member_join	플러스앱 경로 가입회원 여부 T : 사용함 F : 사용안함

Request Copy

Response Copy

Edit distribution group

PUT /api/v2/admin/recipientgroups/{group_no}

PUT

특정 대량 메일 발송 그룹의 정보를 수정할 수 있습니다.

기본스펙

Property	Description
SCOPE	알림 쓰기권한 (mall.write_notification)
호출건수 제한	30
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
group_no Required 최소값: [1]	발송그룹 번호
group_name Required 최대글자수 : [40자]	발송그룹명
group_description 최대글자수 : [255자]	발송그룹 설명
news_mail	뉴스메일 수신여부 T : 수신허용 F : 수신안함 D : 절대수신안함
sms	SMS 수신여부 T : 수신 F : 수신안함
member_group_no 최소값: [1]	회원등급번호
member_class	회원구분 EC 일본, 베트남 버전에서는 사용할 수 없음. p : 개인 c : 사업자 f : 외국인
member_type	회원타입 vip : 특별관리회원 poor : 불량회원
join_path	가입경로 P : PC M : 모바일
inflow_path	유입경로
inflow_path_detail	유입경로 상세정보
date_type	검색날짜 유형 join : 회원가입일 birthday : 생일 wedding : 결혼기념일 partner : 배우자생일
start_date	검색 시작일
end_date	검색 종료일
solar_calendar	양력여부 T : 양력 F : 음력
age_min 최소: [1]~최대: [99]	나이 검색 최소값
age_max 최소: [1]~최대: [99]	나이 검색 최대값
gender	성별 M : 남자 F : 여자
available_points_min 최소: [0]~최대: [999999999]	적립금 검색 최소값
available_points_max 최소: [0]~최대: [999999999]	적립금 검색 최대값
use_mobile_app	모바일앱 사용여부 T : 사용 F : 사용안함
plusapp_member_join	플러스앱 경로 가입회원 여부 T : 사용함 F : 사용안함

Request Copy

Response Copy

Delete distribution group

DELETE /api/v2/admin/recipientgroups/{group_no}

DELETE

특정 대량 메일 발송 그룹을 삭제할 수 있습니다.

기본스펙

Property	Description
SCOPE	알림 쓰기권한 (mall.write_notification)
호출건수 제한	30

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

group_no
Required

최소값: [1]

발송그룹 번호

Request Copy

Response Copy

Sms

SMS를 통해 회원 혹은 특정 휴대전화 번호로 SMS메시지를 발송할 수 있습니다.
SMS API를 사용하기 위해서는 먼저 쇼핑몰에서 SMS 발송 서비스를 사용하고 있는지 확인이 필요합니다.

Endpoints

POST /api/v2/admin/sms

Sms properties

Attribute	Description
queue_code	큐 코드

Send a SMS

POST /api/v2/admin/sms

POST

SMS를 발송할 수 있습니다.
**해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	알림 쓰기권한 (mall.write_notification)
호출건수 제한	1
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no	멀티쇼핑몰 번호 DEFAULT 1
sender_no Required	발신자 아이디 발신자의 고유한 일련번호
content Required	메시지
recipients 배열 최대사이즈: [100]	수신자 전화번호
member_id 배열 최대사이즈: [100]	회원아이디
group_no	회원등급번호 0 : 전체 등급
exclude_unsubscriber	수신거부자 제외 발송 여부 수신거부자를 제외하고 발송할지 여부를 설정할 수 있음. T : 제외 F : 포함 DEFAULT T
type	발송 타입 SMS 의 발송 타입. SMS 는 1건당 최대 90byte 까지 입력 가능하고 90byte 초과 시 여러 개로 나눠서 발송한다. LMS 는 1건당 최대 2000byte 까지 입력 가능하다. SMS : 단문 LMS : 장문 DEFAULT SMS
title	제목

Request Copy

Response Copy

Sms balance

Endpoints

GET /api/v2/admin/sms/balance

Sms balance properties

Attribute	Description
balance	SMS 잔여 건수
sms_count	단문(SMS) 발송 가능 건수
lms_count	장문(LMS) 발송 가능 건수

Retrieve the SMS balance

GET /api/v2/admin/sms/balance

GET

기본스펙

Property	Description
SCOPE	알림 읽기권한 (mall.read_notification)
호출건수 제한	40

Request Copy

Response Copy

Sms senders

SMS 발신자(Sms senders)는 SMS를 발송할 발신번호를 나타냅니다. SMS 발신자의 발신번호는 반드시 본인인증이 되어있어야 합니다.
SMS 발신자는 SMS에 속해있는 하위 리소스입니다.

Endpoints

GET /api/v2/admin/sms/senders

Sms senders properties

Attribute

Description

sender_no

발신자 아이디

발신자의 고유한 일련번호

sender

발신자 번호

발신자의 전화번호

auth_status

인증 상태

발신자의 전화번호의 인증 상태.
인증완료 상태인 발신자로만 SMS 를 발송할 수 있다.

00 : 삭제
10 : 등록
20 : 심사중
30 : 인증완료
40 : 반려

Retrieve a list of SMS senders

GET /api/v2/admin/sms/senders

GET

쇼핑몰에 등록된 SMS 발신자를 목록으로 조회할 수 있습니다.
해당 API는 한국어 쇼핑몰에서만 사용 가능합니다.

기본스펙

Property	Description
SCOPE	알림 읽기권한 (mall.read_notification)
호출건수 제한	40

요청사양

Parameter

Description

offset

최대값: [8000]

조회결과 시작위치

DEFAULT 0

limit

최소: [1]~최대: [100]

조회결과 최대건수

조회하고자 하는 최대 건수를 지정할 수 있음.
예) 10 입력시 10건만 표시함.

DEFAULT 10

Request Copy

Response Copy

Translations categories

상품 분류 번역 정보(Translations categories)는, 상품 분류의 번역 정보를 조회하거나 수정할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/translations/categories
PUT /api/v2/admin/translations/categories/{category_no}

Translations categories properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
category_no	분류 번호
translations	번역 정보

Retrieve a list of product category translations

GET /api/v2/admin/translations/categories

GET

상품 분류의 번역 정보를 조회할 수 있습니다.
언어 코드, 메타태그 등의 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	번역 읽기권한 (mall.read_translation)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
category_no	분류 번호 ,(콤마)로 여러 건을 검색할 수 있다.
language_code	언어 코드 번역 정보의 언어 코드에 해당되는 번역 정보를 검색 언어별로 번역된 정보에서 검색하고자 하는 언어를 선택하면, 해당 언어에 대한 번역 내용을 확인할 수 있습니다. ,(콤마)로 여러 건을 검색할 수 있다.
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Update product category translation

PUT /api/v2/admin/translations/categories/{category_no}

PUT

상품 분류의 번역 정보를 수정할 수 있습니다.
번역정보 수정시, 언어 코드는 필수 입력 항목입니다.

기본스펙

Property	Description
SCOPE	번역 쓰기권한 (mall.write_translation)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
category_no Required	분류 번호
translations	번역 정보
language_code Required 언어 코드 category_name 분류명 seo Array meta_title 브라우저 타이틀 meta_author 메타태그1 : Author meta_description 메타태그2 : Description meta_keywords 메타태그3 : Keywords

Request Copy

Response Copy

Translations products

상품 번역 정보(Translations products)는, 상품의 번역 정보를 조회하거나 수정할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/translations/products
PUT /api/v2/admin/translations/products/{product_no}

Translations products properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
product_no	상품번호
product_name 최대글자수 : [250자]	상품명
translations	번역 정보

Retrieve a list of product translations

GET /api/v2/admin/translations/products

GET

상품의 번역 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	번역 읽기권한 (mall.read_translation)
호출건수 제한	40

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
product_no	상품번호 ,(콤마)로 여러 건을 검색할 수 있다.
product_name	상품명 상품의 상품명에 해당되는 번역 정보를 검색 ,(콤마)로 여러 건을 검색할 수 있다.
language_code	언어 코드 번역 정보의 언어 코드에 해당되는 번역 정보를 검색 언어별로 번역된 정보에서 검색하고자 하는 언어를 선택하면, 해당 언어에 대한 번역 내용을 확인할 수 있습니다. ,(콤마)로 여러 건을 검색할 수 있다.
offset 최대값: [8000]	조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 DEFAULT 10

Request Copy

Response Copy

Update product translation

PUT /api/v2/admin/translations/products/{product_no}

PUT

상품의 번역 정보를 수정할 수 있습니다.
번역정보 수정시, 언어 코드는 필수 입력 항목입니다.

기본스펙

Property	Description
SCOPE	번역 쓰기권한 (mall.write_translation)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
shop_no 최소값: [1]	멀티쇼핑몰 번호 DEFAULT 1
product_no Required	상품번호
translations	번역 정보
language_code Required 언어 코드 product_name 상품명 product_tag 상품 검색어 payment_info 상품결제안내 shipping_info 상품배송안내 exchange_info 교환/반품안내 service_info 서비스문의/안내 summary_description 상품요약설명 simple_description 상품 간략 설명 description 상품상세설명 mobile_description 모바일 상품 상세설명 product_material 상품소재 seo Array meta_title 브라우저 타이틀 meta_author 메타태그1 : Author meta_description 메타태그2 : Description meta_keywords 메타태그3 : Keywords meta_alt 상품 이미지 Alt 텍스트 options Array name 옵션명 value 옵션값

Request Copy

Response Copy

Translations store

상점 번역 정보(Translations store)는, 상점의 번역 정보를 조회하거나 수정할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/translations/store
PUT /api/v2/admin/translations/store

Translations store properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
translations	번역 정보

Retrieve a list of store translations

GET /api/v2/admin/translations/store

GET

상점의 번역 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	번역 읽기권한 (mall.read_translation)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

language_code

언어 코드

언어별로 번역된 정보에서 검색하고자 하는 언어를 선택하면, 해당 언어에 대한 번역 내용을 확인할 수 있습니다.

,(콤마)로 여러 건을 검색할 수 있다.

Request Copy

Response Copy

Update the translations of a store

PUT /api/v2/admin/translations/store

PUT

상점의 번역 정보를 수정할 수 있습니다.
번역정보 수정시, 언어 코드는 필수 입력 항목입니다.

기본스펙

Property	Description
SCOPE	번역 쓰기권한 (mall.write_translation)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

translations

번역 정보

language_code
Required
언어 코드

shop_name
쇼핑몰명

company_name
상호명

company_registration_no
사업자등록번호

president_name
대표자명

phone
전화번호

email
이메일

fax
팩스번호

zipcode
우편번호

address1
기본 주소

address2
상세 주소

customer_service_phone
고객센터 상담/주문 전화

customer_service_hours
고객센터 운영시간

privacy_officer_name
개인정보보호 책임자명

privacy_officer_email
개인정보보호 책임자 이메일

Request Copy

Response Copy

Translations themes

테마 번역 정보(Translations themes)는, 다국어 코드화된 디자인 스킨에 탑재된 번역 정보를 조회하거나 수정할 수 있는 기능입니다.

Endpoints

GET /api/v2/admin/translations/themes
GET /api/v2/admin/translations/themes/{skin_no}
PUT /api/v2/admin/translations/themes/{skin_no}

Translations themes properties

Attribute	Description
skin_no	디자인 번호
translations	번역 정보
skin_code	디자인 코드
skin_translation	디자인 번역 정보

Retrieve a list of theme translations

GET /api/v2/admin/translations/themes

GET

디자인의 디자인 번역 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	번역 읽기권한 (mall.read_translation)
호출건수 제한	40

Request Copy

Response Copy

Retrieve a theme translation

GET /api/v2/admin/translations/themes/{skin_no}

GET

특정 디자인의 디자인 번역 정보를 조회할 수 있습니다.

기본스펙

Property	Description
SCOPE	번역 읽기권한 (mall.read_translation)
호출건수 제한	40

요청사양

Parameter	Description
skin_no Required	디자인 번호
language_code Required	언어 코드

Request Copy

Response Copy

Update a theme translation

PUT /api/v2/admin/translations/themes/{skin_no}

PUT

특정 디자인의 디자인 번역 정보를 수정할 수 있습니다.
디자인 번역정보 수정시, 언어 코드와 소스 코드는 필수 입력 항목입니다.

기본스펙

Property	Description
SCOPE	번역 쓰기권한 (mall.write_translation)
호출건수 제한	40
1회당 요청건수 제한	1

요청사양

Parameter	Description
skin_no Required	디자인 번호
skin_translation	디자인 번역 정보
language_code Required 언어 코드 source Required 소스 코드

Request Copy

Response Copy

Financials dailyvisits

일별 방문수(Financials dailyvisits)는 검색 기간 내의 일별 방문수를 제공합니다.

Endpoints

GET /api/v2/admin/financials/dailyvisits

Financials dailyvisits properties

Attribute	Description
shop_no	멀티쇼핑몰 번호
date	날짜
visitors_count	방문수

Retrieve a count of dailyvisits

GET /api/v2/admin/financials/dailyvisits

GET

검색 기간 내의 일별 방문수를 조회합니다.

해당 API는 특정 클라이언트만 사용할 수 있는 API입니다. 사용하시려면 카페24 개발자센터로 문의해주세요.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	40

요청사양

Parameter

Description

shop_no

최소값: [1]

멀티쇼핑몰 번호

DEFAULT 1

start_date
Required

날짜

검색 시작일

end_date
Required

날짜

검색 종료일

Request Copy

Response Copy

Parameter	Description
shop_no	멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1
category_depth 최소: [1]~최대: [4]	분류 Depth 조회하고자 하는 상품분류의 차수 검색
category_no	분류 번호 조회하고자 하는 상품분류의 번호
parent_category_no	부모 분류 번호 조회하고자 하는 상품분류의 부모 상품분류 번호 검색 대분류만 검색하고자 할 경우 parent_category_no =1 로 검색한다.
category_name	분류명 검색어를 분류명에 포함하고 있는 상품분류 검색(대소문자 구분 없음)
offset 최대값: [8000]	조회결과 시작위치 조회결과 시작위치 DEFAULT 0
limit 최소: [1]~최대: [100]	조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. 예) 10 입력시 10건만 표시함. DEFAULT 10

Store

Product

Order

Customer

Community

Design

Promotion

Application

Category

Collection

Supply

Shipping

Salesreport

Personal

Privacy

Mileage

Notification

Translation

Analytics

non-print

API Index

Introduction

Cafe24 API

API Diagram

Request/Response Format

Method

Admin API Intro

API Status Code

How to use GET API

1. 검색조건 추가

2. 콤마로 여러 건을 검색

3. 멀티쇼핑몰 정보 조회

4. 상세 조회와 단건 조회

5. Pagination

6. 특정 항목 조회

7. 하위 리소스 조회

API Limit

Versioning

Authentication

Get Authentication Code

Get Access Token

Get Access Token using refresh token

Revoke Access Token

Store

Activitylogs

Activitylogs properties

Retrieve a list of action logs

GET

기본스펙

요청사양

Retrieve an action log

GET

기본스펙

요청사양

Automessages arguments

Automessages arguments properties

Retrieve the list of available variables for automated messages

GET

기본스펙

요청사양

Automessages setting

Automessages setting properties

Retrieve the automated message settings

GET

기본스펙

요청사양

Update an automated message

PUT

기본스펙

요청사양

Coupons setting

Coupons setting properties

Retrieve coupon settings

GET

기본스펙

요청사양

Update coupon settings

PUT

기본스펙

요청사양