non-print

API Index

Introduction

D.Collection API

D.Collection API는 카페24 쇼핑몰의 판매 촉진을 유도하기 위한 마케팅/광고 서비스 및 이에 수반되는 제반 서비스를 제작하는 카페24의 승인을 받은 제휴사에 제공되는 API입니다.

본 API를 통해 취득한 정보는 사전 승인되지 않은 채널(또는 미디어) 및 목적을 위해 사용할 수 없습니다.

D.Collection API는 Basic Auth 기반의 인증 시스템과 표준 HTTP Request Method, 리소스를 예측할 수 있는 엔드포인트 URL, HTTP 코드 기반의 에러 메시지를 제공합니다.

Request/Response Format

API 요청과 응답은 JSON Format을 지원합니다.
개인정보 보호를 위하여 D.Collection API는 HTTPS 프로토콜만 지원합니다.
Dates 속성은 ISO_8601 Format으로 제공합니다. : YYYY-MM-DDTHH:MM:SS+09:00
결제 화폐는 ISO_4217 표준에 따라 요청합니다.

요청 예제 (조회)

정상 응답 예제

{
  "resource": {
      "key": "value",
      "key": "value"
   }
}

에러 응답 예제

{
  "error": {
      "code": "error code",
      "message": "error message",
      "more_info": {
      }
  }
}

Method

각 리소스 별로 Read를 지원하며 표준 HTTP Method를 사용하여 API를 사용할 수 있습니다.

GET : 해당 리소스의 정보를 조회(Read)합니다.

D.Collection API Intro

D.Collection API는 D.Collection 프로그램 참여 쇼핑몰의 정보를 조회하는데 적합합니다. D.Collection API는 해당 리소스의 정보를 대부분 조회할 수 있으며 Basic Auth 방식의 별도 인증을 통과한 경우에만 사용할 수 있습니다.

  사용 예시  
 상점 조회 : https://dcollection-api.cafe24.com/api/shops
상품 조회 : https://dcollection-api.cafe24.com/api/products?dcollection_product_category={dcollection_product_category} 

API Status Code

Code	발생하는 사례	오류 해결 방법
200	GET 성공
401	1) Access Token 없이 호출한 경우 2) API에서 요구한 Access Token 가 유효하지 않은 경우 3) 인증을 요청한 client 권한이 유효하지 않은 경우	유효한 Access Token를 사용하여 요청하였는지 확인합니다
404	1) API URL을 잘못 호출한 경우 2) 리소스를 찾을 수 없을 경우	엔드포인트 URL의 오류가 있는지 API문서를 참고하여 확인합니다.
422	조회/처리 요청시 값이 정해진 스펙과 다를 경우 1) 필수 파라메터 누락함 2) 파라미터에 유효한 타입의 값을 넣지 않을 경우	API문서를 참고하여 필수 파라미터가 입력되지 않았거나 유효하지 않은 타입의 값을 입력하지 않았는지 확인합니다.
429	클라이언트의 API 요청이 최대 허용 요청 건수(1분에 최대 40회)를 넘은 경우	API 최대 허용 요청 건수를 초과하지 않도록 잠시 후 다시 요청합니다.
500	내부 서버 에러, 알 수 없는 에러	개발자센터로 문의해주세요.
503	현재 서버가 다운된 경우	개발자센터로 문의해주세요.
504	요청 시간이 초과된 경우(Timeout)	일시적으로 에러가 발생하여 응답이 지연되고 있습니다. 잠시 후에 다시 시도해주세요.

How to use GET API

D.Collection API는 데이터를 조회하는 여러가지 방법을 제공하고 있습니다.

다음은 API 조회시 여러가지 파라메터를 사용하여 다양하게 데이터를 호출할 수 있는 방법을 설명하고 있습니다.

1. 검색조건 추가

검색조건은 엔드포인트에 파라메터를 추가하여 검색할 수 있습니다.

여러 조건을 같이 검색할 경우 "&" 구분자를 이용하여 검색 조건을 추가할 수 있습니다.

API에서 지원하는 경우, 타임존을 사용하여 날짜와 시간 검색을 할 수 있습니다.

  검색조건 추가  
 예) 특정 상점 이름을 가진 상점 조회
GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly

예) 특정 상점 이름과 특정 속성을 갖고있는 상점 조회
GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly&shop_properties=hartebeest

예) 특정 카테고리를 갖고있는 상품 조회
GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802

예) 특정 카테고리와 특정 상점 이름 갖고있는 상품 조회
GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&shop_name=안다르 

2. 콤마로 여러 건을 검색

API에서 지원하는 경우, 콤마(,)를 사용하여 여러 값을 동시에 검색할 수 있습니다. (단, 100개 항목 이하로 입력 해주세요.)

콤마(,)로 추가한 검색 조건은 OR 조건으로, 검색 조건에 해당되는 모든 값들이 검색됩니다.

  콤마로 여러 건을 검색  
 예) 특정 상점 이름들을 갖고있는 상점조회
GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly,reseda

예) 특정 카테고리와 특정 상품 이름들을 갖고있는 상품조회
GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&product_name=안다르,에어쿨링 

3. Pagination

조회 결과가 많을 경우, 정해진 'limit' 기본 값만큼 결과가 조회됩니다.

'limit' 파라메터를 이용하여 조회 건수를 확장할 수 있으며, API마다 정의된 최대 값만큼만 확장할 수 있습니다.

'limit' 최대 값으로 모든 데이터를 조회할 수 없는 경우, 'offset' 파라메터를 사용할 수 있습니다.

  Pagination  
 예) 상점 100개 조회
GET https://dcollection-api.cafe24.com/api/shops?limit=100

예) 상품 100개 조회
GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&limit=100

예) 201번째 상점부터 300번째 상점까지 조회
GET https://dcollection-api.cafe24.com/api/shops?limit=100&offset=200

예) 201번째 상품부터 300번째 상품까지 조회
GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&limit=100&offset=200 

API Limit

D.Collection API는 라라벨 쓰로틀 미들웨어를 사용하여 IP당 1분에 최대 40회까지 요청 가능하도록 호출건 수를 제한하고 있습니다.

한번 호출 시 1회씩 감소하며, 1분 동안 40회 이상의 콜이 발생하면 429에러(Too Many Request)를 반환합니다.

Header에 X-Api-Call-Limit을 확인하면 429에러를 피할 수 있습니다. API 호출 횟수와 1분당 최대 호출 가능 횟수를 각각 확인할 수 있습니다.

X-Api-Call-Limit : 1/40

Shop

Shops

Endpoints

GET /api/shops

Shops properties

Attribute	Description
dcollection_store_category	D.Collection 상점 표준 카테고리
store_id	상점 아이디
shop_name	상점명
shop_no	멀티쇼핑몰 번호
shop_url	상점 대표 도메인
shop_currency_code	결제 화폐 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
shop_language	상점 언어 ko_KR : 한국어 en_US : 영어 zh_CN : 중국어(간체) zh_TW : 중국어(번체) ja_JP : 일본어 vi_VN : 베트남어
shop_grade	상점 인기도 black : 인기지수 90 이상 purple : 인기지수 80 이상 green : 인기지수 70 이상 orange : 인기지수 70 미만
shop_popular_age	상점 인기 연령대 teenager : 10대 twenties : 20대 thirties : 30대 forties : 40대 etc : 기타
shop_sex	인기 성별 F : 여성 M : 남성
shop_region	인기 지역 서울 경기 인천 강원 충북 세종 충남 대전 경북 대구 울산 부산 경남 전북 전남 광주 제주
shop_tags	상점 태그 코드
social_logins	SNS 로그인 연동 채널 facebook : 페이스북 kakao : 카카오 naver : 네이버 line : 라인 google : 구글 apple : 애플
use_cafe24pay	상점의 카페24페이 사용여부 true : 사용함 false : 사용안함
use_naverpay	상점의 네이버페이 사용여부 true : 사용함 false : 사용안함
use_EMS	상점의 우체국EMS 사용여부 true : 사용함 false : 사용안함
shipping_fee_type	상점의 기본 배송비 유형 T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과 E : 자동 책정 배송비(EMS) 사용 F : 착불
benefits	상점에서 제공하는 고객 혜택 유형 DP : 기간 할인 DR : 재구매 할인 DQ : 대량구매 할인 DM : 회원 할인 DN : 신규 상품 할인 DV : 배송비 할인 PG : 사은품 PB : 1+N 이벤트
global_payment_type	상점에서 지원하는 해외 결제 서비스 AX : 엑시즈 EX : 엑심베이 PP : 페이팔 CG : 위챗페이 EY : ECPAY PW : 페이먼트월
created_date 날짜	상점 생성일
updated_date 날짜	상점 업데이트일

Retrieve a list of stores

GET /api/shops

GET

기본스펙

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

요청사양

Parameter	Description
dcollection_store_category	D.Collection 상점 표준 카테고리 검색 가능한 값 : 카테고리 번호 dcollection_store_category
shop_name 배열 최대사이즈: [3]	상점명 ,(콤마)로 여러 건을 검색할 수 있다.
store_id	상점 아이디
shop_no 배열 최대사이즈: [3]	멀티쇼핑몰 번호 ,(콤마)로 여러 건을 검색할 수 있다.
shop_currency_code	결제 화폐 검색 가능한 값 : ISO_4217 통화 코드 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
shop_language	상점 언어 ko_KR : 한국어 en_US : 영어 zh_CN : 중국어(간체) zh_TW : 중국어(번체) ja_JP : 일본어 vi_VN : 베트남어
shop_grade	상점 인기도 black : 인기지수 90 이상 purple : 인기지수 80 이상 green : 인기지수 70 이상 orange : 인기지수 70 미만
shop_popular_age	상점 인기 연령대 teenager : 10대 twenties : 20대 thirties : 30대 forties : 40대 etc : 기타
shop_sex	인기 성별 F : 여성 M : 남성
shop_region	인기 지역 서울 경기 인천 강원 충북 세종 충남 대전 경북 대구 울산 부산 경남 전북 전남 광주 제주
shop_tags 배열 최대사이즈: [10]	상점 태그 검색 가능한 값 : 상점 태그 코드 dcollection_store_taglist ,(콤마)로 여러 건을 검색할 수 있다.
use_cafe24pay	상점의 카페24페이 사용여부 true : 사용함 false : 사용안함
use_naverpay	상점의 네이버페이 사용여부 true : 사용함 false : 사용안함
use_EMS	상점의 우체국EMS 사용여부 true : 사용함 false : 사용안함
social_logins	SNS 로그인 연동 채널 facebook : 페이스북 kakao : 카카오 naver : 네이버 line : 라인 google : 구글 apple : 애플
shipping_fee_type	상점의 기본 배송비 유형 T : 배송비 무료 R : 고정배송비 사용 M : 구매 금액에 따른 부과 D : 구매 금액별 차등 배송료 사용 W : 상품 무게별 차등 배송료 사용 C : 상품 수량별 차등 배송료 사용 N : 상품 수량에 비례하여 배송료 부과 E : 자동 책정 배송비(EMS) 사용 F : 착불
benefits	상점에서 제공하는 고객 혜택 유형 DP : 기간 할인 DR : 재구매 할인 DQ : 대량구매 할인 DM : 회원 할인 DN : 신규 상품 할인 DV : 배송비 할인 PG : 사은품 PB : 1+N 이벤트
global_payment_type	상점에서 지원하는 해외 결제 서비스 AX : 엑시즈 EX : 엑심베이 PP : 페이팔 CG : 위챗페이 EY : ECPAY PW : 페이먼트월
created_start_date 날짜	상점 생성일 검색 시작 값
created_end_date 날짜	상점 생성일 검색 종료 값
limit 최소: [1]~최대: [100]	조회 결과 최대 건수 DEFAULT 10
offset 최소: [0]~최대: [5000]	조회 결과 시작 위치 DEFAULT 0
sort	정렬 순서 값 created_date : 상점 생성일 shop_name : 상점명
order	정렬 순서 asc : 오름차순 desc : 내림차순

Request Copy

Response Copy

Product

Products

Endpoints

GET /api/products
GET /api/products/count

Products properties

Attribute	Description
dcollection_product_category	D.Collection 상품 표준 카테고리
product_ukey	상품의 고유키
shop_name	상점명
store_id	상점 아이디
shop_no	멀티쇼핑몰 번호
shop_grade	상점 인기도 black : 인기지수 90 이상 purple : 인기지수 80 이상 green : 인기지수 70 이상 orange : 인기지수 70 미만
shop_language	상점 언어 ko_KR : 한국어 en_US : 영어 zh_CN : 중국어(간체) zh_TW : 중국어(번체) ja_JP : 일본어 vi_VN : 베트남어
shop_currency_code	결제 화폐 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
product_name	상품명
product_no	상품번호
product_code	상품코드
product_url	상품 페이지 URL
product_status_type	상품 상태 N : 신상품 B : 반품 상품 R : 재고 상품 U : 중고 상품 E : 전시 상품 F : 리퍼 상품 S : 스크래치 상품
price	상품 판매가
pc_discount_price	PC 할인 판매가
mobile_discount_price	모바일 할인 판매가
is_pc_discount	PC 할인 여부 true : 사용함 false : 사용안함
is_mobile_discount	모바일 할인 여부 true : 사용함 false : 사용안함
pc_discount_rate	PC 할인율
mobile_discount_rate	모바일 할인율
is_free_shipping	무료 배송 상품 여부 true : 사용함 false : 사용안함
is_international_shipping	해외 배송 가능 여부 true : 사용함 false : 사용안함
international_shipping_country	상품이 배송될 수 있는 해외 국가
is_free_gift	사은품 제공 여부 true : 사용함 false : 사용안함
is_coupon_discount	할인 쿠폰 제공 여부 true : 사용함 false : 사용안함
product_options	상품 옵션
brand_name	브랜드 이름
product_standard_tags	D.Collection에서 제공하는 상품 표준 태그
product_popular_age	상품 인기 연령대 teenager : 10대 twenties : 20대 thirties : 30대 forties : 40대 etc : 기타
detail_image	상세 이미지 URL
list_image	목록 이미지 URL
tiny_image	작은 목록 이미지 URL
small_image	축소 이미지 URL
review_count	상품 리뷰 수
review_score	상품 리뷰 평점
hits_count	페이지뷰수
expiration_date 날짜	상품 유효기간
created_date 날짜	상품 생성일
updated_date 날짜	상품 업데이트일

Retrieve a list of products

GET /api/products

GET

기본스펙

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

요청사양

Parameter	Description
dcollection_product_category Required	D.Collection 상품 표준 카테고리 Metaport 상품 표준 카테고리 검색 가능한 값 : 중분류 또는 소분류 카테고리 번호 dcollection_product_category 중분류가 같은 소분류 카테고리에 한하여 소분류 카테고리는 (콤마)로 최대 10개까지 검색 중분류 상품 카테고리와 소분류 상품 카테고리를 동시 요청 시 소분류 상품 카테고리만 검색
product_ukey 배열 최대사이즈: [100]	상품의 고유키 특정 상점의 상품을 구분하는 고유한 값 검색 가능한 값 구문 : "${mall_id}_${shop_no}_${product_no}" 예시 : cafe24_1_1356 ,(콤마)로 여러 건을 검색할 수 있다.
shop_name 배열 최대사이즈: [3]	상점명 ,(콤마)로 여러 건을 검색할 수 있다.
store_id	상점 아이디 product_ukey와 동시 사용 불가
shop_no 배열 최대사이즈: [3]	멀티쇼핑몰 번호 product_ukey와 동시 사용 불가 ,(콤마)로 여러 건을 검색할 수 있다.
shop_grade 배열 최대사이즈: [4]	상점 인기도 ,(콤마)로 여러 건을 검색할 수 있다. black : 인기지수 90 이상 purple : 인기지수 80 이상 green : 인기지수 70 이상 orange : 인기지수 70 미만
shop_language	상점 언어 ko_KR : 한국어 en_US : 영어 zh_CN : 중국어(간체) zh_TW : 중국어(번체) ja_JP : 일본어 vi_VN : 베트남어
shop_currency_code	결제 화폐 검색 가능한 값 : ISO_4217 통화 코드 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
product_name 배열 최대사이즈: [3]	상품명 ,(콤마)로 여러 건을 검색할 수 있다.
product_no 배열 최대사이즈: [3]	상품번호 product_ukey와 동시 사용 불가 ,(콤마)로 여러 건을 검색할 수 있다.
product_status_type	상품 상태 N : 신상품 B : 반품 상품 R : 재고 상품 U : 중고 상품 E : 전시 상품 F : 리퍼 상품 S : 스크래치 상품
price_min	상품 판매가 검색 최소 값 소수점 2째 자리까지 입력
price_max	상품 판매가 검색 최대 값 소수점 2째 자리까지 입력
is_pc_discount	PC 할인 여부 true : 사용함 false : 사용안함
is_mobile_discount	모바일 할인 여부 true : 사용함 false : 사용안함
pc_discount_price_min	PC 할인 판매가 검색 최소 값 PC 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
pc_discount_price_max	PC 할인 판매가 검색 최대 값 PC 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
mobile_discount_price_min	모바일 할인 판매가 검색 최소 값 모바일 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
mobile_discount_price_max	모바일 할인 판매가 검색 최대 값 모바일 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
pc_discount_rate_min	PC 할인율 최소 값
pc_discount_rate_max	PC 할인율 최대 값
mobile_discount_rate_min	모바일 할인율 최소 값
mobile_discount_rate_max	모바일 할인율 최대 값
is_free_shipping	무료 배송 상품 여부 true : 사용함 false : 사용안함
is_international_shipping	해외 배송 가능 여부 true : 사용함 false : 사용안함
international_shipping_country	상품이 배송될 수 있는 해외 국가
is_free_gift	사은품 제공 여부 true : 사용함 false : 사용안함
is_coupon_discount	할인 쿠폰 제공 여부 true : 사용함 false : 사용안함
review_count_min	상품 리뷰 수 최소 값
review_count_max	상품 리뷰 수 최대 값
review_score_min 최소: [0]~최대: [5]	상품 리뷰 평점 최소 값 소수점 2째 자리까지 입력 리뷰 평점이 해당 범위 이상인 상품 검색
review_score_max 최소: [0]~최대: [5]	상품 리뷰 평점 최대 값 소수점 2째 자리까지 입력 리뷰 평점이 해당 범위 이상인 상품 검색
brand_name	브랜드 이름 브랜드 이름과 일치하는 상품 검색
product_standard_tags	D.Collection에서 제공하는 상품 표준 태그 상품 표준 태그 API를 조회하여 지원되는 태그 키와 값 확인 가능 product_standard_tags 하위요소 standard_tag_key 태그 키 standard_tag_values 태그 값 하나의 태그 키에 대한 태그 값은 ,(콤마)로 최대 10개까지 검색 가능 ,(콤마)로 여러 건을 검색할 수 있다.
product_popular_age	상품 인기 연령대 검색 가능한 값 - teenager : 10대 - twenties : 20대 - thirties : 30대 - forties : 40대 - etc : 기타 teenager : 10대 twenties : 20대 thirties : 30대 forties : 40대 etc : 기타
created_start_date 날짜	상품 생성일 검색 시작 값
created_end_date 날짜	상품 생성일 검색 종료 값
updated_start_date 날짜	상품 업데이트일 검색 시작 값
updated_end_date 날짜	상품 업데이트일 검색 종료 값
limit 최소: [1]~최대: [100]	조회 결과 최대 건수 DEFAULT 10
offset 최소: [0]~최대: [5000]	조회 결과 시작 위치 DEFAULT 0
sort	정렬 순서 값 mobile_discount_price : 모바일 할인 판매가 pc_discount_price : PC 할인 판매가 mobile_discount_rate : 모바일 할인율 pc_discount_rate : PC 할인율 price : 상품 판매가 created_date : 상품 생성일 product_name : 상품명 review_count : 상품 리뷰 수 review_score : 상품 리뷰 평점 hits_count : 페이지뷰수 popularity_score : 인기지수
order	정렬 순서 asc : 오름차순 desc : 내림차순

Request Copy

Response Copy

Retrieve the number of product items

GET /api/products/count

GET

기본스펙

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

요청사양

Parameter	Description
dcollection_product_category Required	D.Collection 상품 표준 카테고리 검색 가능한 값 : 중분류 또는 소분류 카테고리 번호 dcollection_product_category 중분류가 같은 소분류 카테고리에 한하여 소분류 카테고리는 (콤마)로 최대 10개까지 검색 중분류 상품 카테고리와 소분류 상품 카테고리를 동시 요청 시 소분류 상품 카테고리만 검색
product_ukey 배열 최대사이즈: [100]	상품의 고유키 특정 상점의 상품을 구분하는 고유한 값 검색 가능한 값 구문 : "${mall_id}_${shop_no}_${product_no}" 예시 : cafe24_1_1356 ,(콤마)로 여러 건을 검색할 수 있다.
shop_name 배열 최대사이즈: [3]	상점명 ,(콤마)로 여러 건을 검색할 수 있다.
store_id	상점 아이디 product_ukey와 동시 사용 불가
shop_no 배열 최대사이즈: [3]	멀티쇼핑몰 번호 product_ukey와 동시 사용 불가 ,(콤마)로 여러 건을 검색할 수 있다.
shop_grade 배열 최대사이즈: [4]	상점 인기도 ,(콤마)로 여러 건을 검색할 수 있다. black : 인기지수 90 이상 purple : 인기지수 80 이상 green : 인기지수 70 이상 orange : 인기지수 70 미만
shop_language	상점 언어 ko_KR : 한국어 en_US : 영어 zh_CN : 중국어(간체) zh_TW : 중국어(번체) ja_JP : 일본어 vi_VN : 베트남어
shop_currency_code	결제 화폐 검색 가능한 값 : ISO_4217 통화 코드 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
product_name 배열 최대사이즈: [3]	상품명 ,(콤마)로 여러 건을 검색할 수 있다.
product_no 배열 최대사이즈: [3]	상품번호 product_ukey와 동시 사용 불가 ,(콤마)로 여러 건을 검색할 수 있다.
product_status_type	상품 상태 N : 신상품 B : 반품 상품 R : 재고 상품 U : 중고 상품 E : 전시 상품 F : 리퍼 상품 S : 스크래치 상품
price_min	상품 판매가 검색 최소 값 소수점 2째 자리까지 입력
price_max	상품 판매가 검색 최대 값 소수점 2째 자리까지 입력
is_pc_discount	PC 할인 여부 true : 사용함 false : 사용안함
is_mobile_discount	모바일 할인 여부 true : 사용함 false : 사용안함
pc_discount_price_min	PC 할인 판매가 검색 최소 값 PC 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
pc_discount_price_max	PC 할인 판매가 검색 최대 값 PC 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
mobile_discount_price_min	모바일 할인 판매가 검색 최대 값 모바일 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
mobile_discount_price_max	모바일 할인 판매가 검색 최대 값 모바일 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
pc_discount_rate_min	PC 할인율 최소 값
pc_discount_rate_max	PC 할인율 최대 값
mobile_discount_rate_min	모바일 할인율 최소 값
mobile_discount_rate_max	모바일 할인율 최대 값
is_free_shipping	무료 배송 상품 여부 true : 사용함 false : 사용안함
is_international_shipping	해외 배송 가능 여부 true : 사용함 false : 사용안함
international_shipping_country	상품이 배송될 수 있는 해외 국가
is_free_gift	사은품 제공 여부 true : 사용함 false : 사용안함
is_coupon_discount	할인 쿠폰 제공 여부 true : 사용함 false : 사용안함
review_count_min	상품 리뷰 수 최소 값
review_count_max	상품 리뷰 수 최대 값
review_score_min 최소: [0]~최대: [5]	상품 리뷰 평점 최소 값 소수점 2째 자리까지 입력 리뷰 평점이 해당 범위 이상인 상품 검색
review_score_max 최소: [0]~최대: [5]	상품 리뷰 평점 최대 값 소수점 2째 자리까지 입력 리뷰 평점이 해당 범위 이상인 상품 검색
brand_name	브랜드 이름 브랜드 이름과 일치하는 상품 검색
product_standard_tags	D.Collection에서 제공하는 상품 표준 태그 상품 표준 태그 API를 조회하여 지원되는 태그 키와 값 확인 가능 product_standard_tags 하위요소 standard_tag_key 태그 키 standard_tag_values 태그 값 하나의 태그 키에 대한 태그 값은 ,(콤마)로 최대 10개까지 검색 가능 ,(콤마)로 여러 건을 검색할 수 있다.
product_popular_age	상품 인기 연령대 teenager : 10대 twenties : 20대 thirties : 30대 forties : 40대 etc : 기타
created_start_date 날짜	상품 생성일 검색 시작 값
created_end_date 날짜	상품 생성일 검색 종료 값
updated_start_date 날짜	상품 업데이트일 검색 시작 값
updated_end_date 날짜	상품 업데이트일 검색 종료 값

Request Copy

Response Copy

Products standardtags

Endpoints

GET /api/products/standardtags

Products standardtags properties

Attribute	Description
standard_tag_key	표준 태그 키
standard_tag_values	표준 태그 값

Retrieve a list of product tag properties

GET /api/products/standardtags

GET

기본스펙

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

요청사양

Parameter	Description
limit 최소: [1]~최대: [100]	조회 결과 최대 건수 DEFAULT 10
offset 최소: [0]~최대: [5000]	조회 결과 시작 위치 DEFAULT 0

Parameter

Description

limit

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

조회 결과 최대 건수

DEFAULT 10

offset

최소: [0]~최대: [5000]

조회 결과 시작 위치

DEFAULT 0

Request Copy

Response Copy

Storeproducts

Endpoints

GET /api/storeproducts

Storeproducts properties

Attribute	Description
dcollection_product_category	D.Collection 상품 표준 카테고리
product_ukey	상품의 고유키
shop_name	상점명
store_id	상점 아이디
shop_no	멀티쇼핑몰 번호
shop_grade	상점 인기도 black : 인기지수 90 이상 purple : 인기지수 80 이상 green : 인기지수 70 이상 orange : 인기지수 70 미만
shop_language	상점 언어 ko_KR : 한국어 en_US : 영어 zh_CN : 중국어(간체) zh_TW : 중국어(번체) ja_JP : 일본어 vi_VN : 베트남어
shop_currency_code	결제 화폐 KRW : ￦ 원 USD : $ 달러 JPY : ¥ 엔 PHP : ₱ 페소
product_name	상품명
product_no	상품번호
product_code	상품코드
product_url	상품 페이지 URL
product_status_type	상품 상태 N : 신상품 B : 반품 상품 R : 재고 상품 U : 중고 상품 E : 전시 상품 F : 리퍼 상품 S : 스크래치 상품
price	상품 판매가
pc_discount_price	PC 할인 판매가
mobile_discount_price	모바일 할인 판매가
is_pc_discount	PC 할인 여부 true : 사용함 false : 사용안함
is_mobile_discount	모바일 할인 여부 true : 사용함 false : 사용안함
pc_discount_rate	PC 할인율
mobile_discount_rate	모바일 할인율
is_free_shipping	무료 배송 상품 여부 true : 사용함 false : 사용안함
is_international_shipping	해외 배송 가능 여부 true : 사용함 false : 사용안함
international_shipping_country	상품이 배송될 수 있는 해외 국가
is_free_gift	사은품 제공 여부 true : 사용함 false : 사용안함
is_coupon_discount	할인 쿠폰 제공 여부 true : 사용함 false : 사용안함
product_options	상품 옵션
brand_name	브랜드 이름
product_standard_tags	D.Collection에서 제공하는 상품 표준 태그
product_popular_age	상품 인기 연령대 teenager : 10대 twenties : 20대 thirties : 30대 forties : 40대 etc : 기타
detail_image	상세 이미지 URL
list_image	목록 이미지 URL
tiny_image	작은 목록 이미지 URL
small_image	축소 이미지 URL
review_count	상품 리뷰 수
review_score	상품 리뷰 평점
hits_count	페이지뷰수
expiration_date 날짜	상품 유효기간
created_date 날짜	상품 생성일
updated_date 날짜	상품 업데이트일

Retrieve a list of products with mall ID

GET /api/storeproducts

GET

기본스펙

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

요청사양

Parameter	Description
store_id Required	상점 아이디 ,(콤마)로 여러 건을 검색할 수 있다.
shop_name 배열 최대사이즈: [3]	상점명 ,(콤마)로 여러 건을 검색할 수 있다.
shop_no 배열 최대사이즈: [3]	멀티쇼핑몰 번호 ,(콤마)로 여러 건을 검색할 수 있다.
product_name	상품명
product_status_type	상품 상태 N : 신상품 B : 반품 상품 R : 재고 상품 U : 중고 상품 E : 전시 상품 F : 리퍼 상품 S : 스크래치 상품
price_min	상품 판매가 검색 최소 값 소수점 2째 자리까지 입력
price_max	상품 판매가 검색 최대 값 소수점 2째 자리까지 입력
is_pc_discount	PC 할인 여부 true : 사용함 false : 사용안함
is_mobile_discount	모바일 할인 여부 true : 사용함 false : 사용안함
pc_discount_price_min	PC 할인 판매가 검색 최소 값 PC 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
pc_discount_price_max	PC 할인 판매가 검색 최대 값 PC 할인 판매가가 해당 범위 이하인 상품 검색 소수점 2째 자리까지 입력
mobile_discount_price_min	모바일 할인 판매가 검색 최소 값 모바일 할인 판매가가 해당 범위 이상인 상품 검색 소수점 2째 자리까지 입력
mobile_discount_price_max	모바일 할인 판매가 검색 최대 값 모바일 할인 판매가가 해당 범위 이하인 상품 검색 소수점 2째 자리까지 입력
pc_discount_rate_min	PC 할인율 최소 값
pc_discount_rate_max	PC 할인율 최대 값
mobile_discount_rate_min	모바일 할인율 최소 값
mobile_discount_rate_max	모바일 할인율 최대 값
is_free_shipping	무료 배송 상품 여부 true : 사용함 false : 사용안함
is_international_shipping	해외 배송 가능 여부 true : 사용함 false : 사용안함
international_shipping_country	상품이 배송될 수 있는 해외 국가 검색 가능한 값 : ISO 3166-1 국가 코드(2자리)
is_free_gift	사은품 제공 여부 true : 사용함 false : 사용안함
is_coupon_discount	할인 쿠폰 제공 여부 true : 사용함 false : 사용안함
review_count_min	상품 리뷰 수 최소 값
review_count_max	상품 리뷰 수 최대 값
review_score_min 최소: [0]~최대: [5]	상품 리뷰 평점 최소 값 허용 범위 : 0.00 ~ 5.00 소수점 2째 자리까지 입력 리뷰 평점이 해당 범위 이상인 상품 검색
review_score_max 최소: [0]~최대: [5]	상품 리뷰 평점 최대 값 허용 범위 : 0.00 ~ 5.00 소수점 2째 자리까지 입력 리뷰 평점이 해당 범위 이하인 상품 검색
brand_name	브랜드 이름 브랜드 이름과 일치하는 상품 검색
product_popular_age	상품 인기 연령대 teenager : 10대 twenties : 20대 thirties : 30대 forties : 40대 etc : 기타
created_start_date 날짜	상품 생성일 검색 시작 값 형식 : yyyy-mm-dd
created_end_date 날짜	상품 생성일 검색 종료 값 형식 : yyyy-mm-dd
updated_start_date 날짜	상품 업데이트일 검색 시작 값 형식 : yyyy-mm-dd
updated_end_date 날짜	상품 업데이트일 검색 종료 값 형식 : yyyy-mm-dd
limit 최소: [1]~최대: [100]	조회 결과 최대 건수 DEFAULT 10
offset 최소: [0]~최대: [5000]	조회 결과 시작 위치 DEFAULT 0
sort	정렬 순서 값 mobile_discount_price : 모바일 할인 판매가 pc_discount_price : PC 할인 판매가 mobile_discount_rate : 모바일 할인율 pc_discount_rate : PC 할인율 price : 상품 판매가 created_date : 상품 생성일 product_name : 상품명 review_count : 상품 리뷰 수 review_score : 상품 리뷰 평점 hits_count : 페이지뷰수 popularity_score : 인기지수 DEFAULT mobile_discount_price
order	정렬 순서 asc : 오름차순 desc : 내림차순 DEFAULT asc

Request Copy

Response Copy