Introduction
Cafe24 API
카페24 쇼핑몰 API는 카페24 쇼핑몰에 연동하여 서비스를 제공하기 위한 앱스토어 입점 개발사, 서드파티 솔루션 제공자 등에 제공하는 API입니다.
카페24 API는 RESTful한 아키텍쳐로서 OAuth 2.0 기반의 인증 시스템과 표준 HTTP Request Method, 리소스를 예측할 수 있는 엔드포인트 URL, HTTP 코드 기반의 에러 메시지를 제공합니다.
Request/Response Format
요청 예제 (조회)
curl -X GET \
'{endpoint_url}' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json'
요청 예제 (등록/수정)
curl -X POST \
'{endpoint_url}' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-d '{ .... }'
정상 응답 예제
{
"request": {
"key": "value",
"key": "value"
}
}
에러 응답 예제
{
"error": {
"code": "에러 코드",
"message": "에러 메세지",
"more_info": {
}
}
}
API 요청과 응답은 JSON Format을 지원합니다.
개인정보 보호를 위하여 카페24 API는 HTTPS 프로토콜만 지원합니다.
Dates 속성은 ISO_8601 Format으로 제공합니다. : YYYY-MM-DDTHH:MM:SS+09:00
Method
각 리소스 별로 Create, Read, Update, Delete를 지원하며 표준 HTTP Method를 사용하여 API를 사용할 수 있습니다.
POST : 해당 Entity를 생성(Create)합니다.
GET : 해당 Entity의 정보를 조회(Read)합니다.
PUT : 해당 Entity를 수정(Update)합니다.
DELETE : 해당 Entity를 삭제(Delete)합니다.
Front API Intro
사용 예시
https://{mallid}.cafe24api.com/api/v2/sampleapi
Front API
Front API는 공개된 정보(상품 진열 정보) 또는 쇼핑몰 이용 고객이 자신의 정보를 조회하거나 게시물 등을 작성할 때 적합합니다. Front API는 Admin API에 비하여 일부 정보는 제한되어있습니다.
API Status Code
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) AccessToken 없이 호출한 경우 2) AccessToken이 유효하지 않은 경우 3) AccessToken이 만료된 경우 4) 알 수 없는 클라이언트일 경우 |
유효한 발급 절차에 따라 발급받은 AccessToken을 사용하였는지 확인합니다. |
401 | Front API 사용시 client_id를 미입력한 경우 | 유효한 클라이언트 ID를 사용하였는지 확인합니다. |
403 | 1) AccessToken은 있으나 해당 Scope에 권한이 없음 2) FrontAPI에서 볼 수 있는 권한이 없을 경우 |
API를 호출할 수 있는 권한이 있는지 API의 Scope 또는 쇼핑몰의 설정을 확인합니다. |
403 | https 프로토콜이 아닌 경우 | API 요청시 https 로 요청하였는지 확인합니다. |
403 | 뉴상품 쇼핑몰이 아닌 경우 | 쇼핑몰이 (뉴)상품관리로 업그레이드 되어야 사용 가능합니다. |
403 | (Admin API 호출시) 쇼핑몰에서 해당 앱이 삭제된 경우 | 쇼핑몰에 앱이 설치되었는지 확인 후 앱을 다시 설치합니다. |
403 | (Front API 호출시) 쇼핑몰에서 해당 앱이 삭제된 경우 | 쇼핑몰에 앱이 설치되었는지 확인 후 앱을 다시 설치합니다. |
404 | 1) API URL을 잘못 호출한 경우 2) 리소스를 찾을 수 없을 경우 3) {#id}가 없는 경우 |
엔드포인트 URL의 오류가 있는지 API 문서를 참고하여 확인합니다. |
422 | 조회/처리 요청시 값이 정해진 스펙과 다를 경우 1) 필수 파라메터 누락함 2) 정해진 스펙과 다를 경우 |
API 문서를 참고하여 필수 파라메터가 입력되지 않았거나 유효하지 않은 값을 입력하였는지 확인합니다. |
429 | 클라이언트의 API 요청이 Bucket을 초과한 경우 | API 최대 허용 요청 건수를 초과하지 않도록 잠시 후 다시 요청합니다. |
500 | 내부 서버 에러, 알 수 없는 에러 | 일시적으로 에러가 발생하였습니다. 잠시 후에 다시 시도합니다. |
503 | 현재 서버가 다운된 경우 | 개발자센터로 문의해주세요. |
503 | 서버가 다운된 경우. API를 사용할 수 없음. | 개발자센터로 문의해주세요. |
504 | 요청 시간이 초과된 경우(Timeout) | 일시적으로 에러가 발생하여 응답이 지연되고 있습니다. 잠시 후에 다시 시도해주세요. |
How to use GET API
검색조건을 추가하기
예) 특정 브랜드 내에서 가격이 1000원 이상인 상품을 검색하고 싶을 경우
GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000
예) 상품 등록일 검색
GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03
파라메터에서 여러조건 검색하기
예) 11번, 12번, 13번 상품의 정보를 조회할 경우
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13
멀티쇼핑몰 정보 조회
예) 2번 쇼핑몰의 상품 조회하기
GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2
상세 조회와 단건 조회
예 ) 128번 상품을 상세 조회하는 방법
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products/128
예) 128번 상품을 파라메터를 이용하여 단건 조회하는 경우
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?product_no=128
Pagination
예 ) 상품을 한번에 100개 조회하기
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?limit=100
예) 201번째 상품부터 300번째 상품까지 조회하기
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?limit=100&offset=200
Field 파라메터
예 ) 상품 조회시 상품명과 상품 번호 파라메터만 조회하기
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no
Embed 파라메터
예) 상품 조회시 재고와 품목 데이터를 함께 조회하기
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products/570?embed=variants,inventories
카페24 API는 데이터를 조회하는 여러가지 방법을 제공하고 있습니다.
다음은 API 조회시 여러가지 파라메터를 사용하여 다양하게 데이터를 호출할 수 있는 방법을 설명하고 있습니다.
1. 검색조건을 추가하기
API 조회시 검색조건은 엔드포인트에 파라메터를 추가하여 검색할 수 있습니다.
여러 조건을 같이 검색할 경우 "&" 구분자를 이용하여 검색 조건을 추가할 수 있습니다.
시작일, 종료일 등 범위를 검색할 경우에도 "&" 구분자를 사용하여 검색할 수 있습니다.
2. 파라메터에서 여러조건 검색하기
API에서 지원하는 경우, 콤마(,)를 사용하여 여러 값을 동시에 검색할 수 있습니다. (단, 100개 항목 이하로 입력 해주세요.)
콤마(,)로 추가한 검색 조건은 OR 조건으로, 해당 검색 조건에 해당되는 모든 값이 검색됩니다.
3. 멀티쇼핑몰 정보 조회
API 조회시 특정 shop_no를 명시하면 해당 멀티쇼핑몰의 정보를 조회할 수 있습니다.
특정 shop_no를 명시하지 않을 경우 1번 쇼핑몰(기본 쇼핑몰)의 정보를 조회합니다.
4. 상세 조회와 단건 조회
대부분의 Entity는 URL에 Entity의 ID를 명시하여 상세 조회할 수 있습니다.
상세조회는 Entity 하나만 조회할 수 있지만, 목록 조회할 경우보다 더 많은 항목이 반환됩니다.
5. Pagination
목록 조회시 조회하는 항목이 너무 많을 경우 모든 결과가 한번에 조회되지 않을 수 있습니다.
한번에 결과를 좀 더 많이 조회하고 싶을 경우 'limit' 파라메터를 사용하여 조회 건수를 확장할 수 있습니다.
'limit' 파라메터를 사용하지 않을 경우 'limit'의 기본값만큼만 조회됩니다.
'limit' 파라메터로 확장할 수 있는 조회건수는 각 API마다 정의된 '최대값'만큼만 확장할 수 있습니다.
만약 'limit 최대값'으로 모든 데이터를 조회할 수 없는 경우 'offset' 파라메터를 사용할 수 있습니다.
'offset' 파라메터는 몇번째 상품부터 조회를 시작할 것인지 정하여, 해당 상품부터 'limit' 갯수만큼의 상품을 다시 조회합니다.
6. Field 파라메터
API의 조회값 중 특정한 값들만 조회하고 싶을 때는 field 파라메터를 사용하여 해당 값들을 조회할 수 있습니다.
7. Embed 파라메터
상품 조회시 상품에 속한 하위 Entity(예. 품목, 재고)를 같이 조회해야할 경우 'embed' 파라메터를 사용하면 하위 Entity의 데이터를 같이 조회할 수 있습니다.
'embed' 파라메터는 지원하는 API에서만 사용이 가능합니다.
API Limit
X-Api-Call-Limit : 1/30
카페24 API는 "Leaky Bucket" 알고리즘으로 작동합니다. Leaky Bucket 알고리즘은 성능을 위해 비정상적으로 많은 API 요청만 제한되고 일상적인 API 요청은 별다른 제약 없이 사용할 수 있는 효과가 있습니다.
카페24 API는 API 요청을 Bucket에 쌓아둡니다. Bucket은 쇼핑몰 당 "호출건 수 제한"만큼 가득차면 API 호출이 제한됩니다. Bucket은 1초에 1회씩 감소하며, 감소한만큼 다시 API 호출을 할 수 있습니다.
만약 앱이 1초에 1회씩 API를 호출한다면 API 호출을 별다른 제약 없이 계속 사용할 수 있습니다.
순간적으로 1초 이내에 "호출건 수 제한" 이상의 콜이 발생한다면 429 에러(Too Many Request)를 반환합니다.
Header에 X-Api-Call-Limit
을 확인하면 429 에러를 피할 수 있습니다. 해당 쇼핑몰에서 얼마나 API를 호출했는지, 그리고 Bucket 여유량은 얼마나 남았는지를 확인할 수 있습니다.
Cart
Cart properties
Attribute | Description |
---|---|
duplicated_item | 장바구니 내의 아이템 코드 중복 여부 장바구니에 추가할 품목에 대하여 중복을 허용할지 여부. T : 품목이 중복됨 |
variants | 품목 품목 정보. 장바구니에 추가할 품목의 개수와 품목 코드. |
product_no | 상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
basket_type | 장바구니 타입 장바구니의 타입. 무이자할부 가능한 상품일 경우 무이자 타입으로 설정 가능. A0000 : 일반 |
prd_detail_ship_fee | 배송비 선결제 설정 배송비의 선불 or 착불 여부. P : 선불 |
Create a cart
Definition
POST 'https://{domain}/api/v2/cart'
POST 'https://{mallid}.cafe24api.com/api/v2/cart'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
var data = {
"request": {
"duplicated_item_check": "T",
"product_no": 950,
"basket_type": "A0000",
"shipping_type": "A",
"prefaid_shipping_fee": "P",
"variants": [
{
"quantity": 1,
"variants_code": "P0000BJU000H"
}
]
}
}
CAFE24API.post('/api/v2/cart', data, function(err, res){
console.log(res);
});
curl -X POST \
'https://{mallid}.cafe24api.com/api/v2/cart' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json' \
-d '{
"request": {
"duplicated_item_check": "T",
"product_no": 950,
"basket_type": "A0000",
"shipping_type": "A",
"prefaid_shipping_fee": "P",
"variants": [
{
"quantity": 1,
"variants_code": "P0000BJU000H"
}
]
}
}'
Response example:
{
"cart": [
{
"duplicated_item": "T",
"variants": [
{
"quantity": 1,
"variants_code": "P0000BJU000H"
},
{
"quantity": 2,
"variants_code": "P0000BJU000M"
}
],
"product_no": 950,
"basket_type": "A0000",
"shipping_type": "A",
"prefaid_shipping_fee": "P"
}
]
}
기본스펙
Property | Description |
---|---|
SCOPE | 개인화정보 쓰기권한 (mall.write_personal) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
variants | 품목 품목 정보. 장바구니에 추가할 품목의 개수와 품목 코드. |
addtional_products | 추가구성상품의 품목 |
product_noRequired |
상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
basket_typeRequired |
장바구니 타입 장바구니의 타입. 무이자할부 가능한 상품일 경우 무이자 타입으로 설정 가능. A0000 : 일반 |
duplicated_item_checkRequired |
장바구니 중복체크 장바구니에 추가할 품목에 대하여 중복을 허용할지 여부. T : 품목 중복체크 |
prefaid_shipping_feeRequired |
배송비 선결제 설정 배송비의 선불 or 착불 여부. P : 선불 |
Categories
상품 분류(Categories)는 쇼핑몰 고객이 상품을 찾기 쉽도록 상품을 진열하거나 분류할 수 있는 카테고리입니다. 상품을 하나 이상의 상품 분류에 진열해야 판매 가능합니다. 하나의 상품은 여러 상품분류에 진열될 수 있습니다.
Categories properties
Attribute | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. |
category_no | 분류 번호 상품분류의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품분류 번호는 중복되지 않음. |
category_depth 최소: [1]~최대: [4] |
분류 Depth 해당 상품분류가 하위 몇 차 상품분류에 있는 카테고리인지 표시함. 1~4차까지 상품분류가 존재한다. |
parent_category_no | 부모 분류 번호 해당 상품분류가 2차(중분류), 3차(소분류), 4차(세분류)일 경우 상위에 있는 상품분류의 번호를 표시함. |
category_name 최대글자수 : [50자] |
분류명 해당 상품분류의 이름을 나타낸다. |
full_category_name | 분류 전체 이름 해당 상품분류가 속해있는 상위 상품분류의 이름을 모두 표시. |
full_category_no | 분류 전체 번호 해당 상품분류가 속해있는 상위 상품분류의 번호를 모두 표시. |
root_category_no | 최상위 분류 번호 해당 상품분류가 속해있는 최상위 상품분류의 분류 번호 표시. |
display_order | 진열 순서 상품분류를 쇼핑몰 운영자가 배치한 순서. |
hash_tags | 쇼핑 큐레이션 해시태그 해당 상품분류의 해시태그 목록 |
List all categories
Definition
GET 'https://{domain}/api/v2/categories'
GET 'https://{mallid}.cafe24api.com/api/v2/categories'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/categories', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/categories' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"categories": [
{
"shop_no": 1,
"category_no": 27,
"category_depth": 1,
"parent_category_no": 1,
"category_name": "(large scale classification) Bottoms",
"full_category_name": {
"1": "(Main Category) Tops",
"2": "(Middle Category) Tees",
"3": "(Small Category) Long Sleeve",
"4": "(Detailed Category) Cropped"
},
"root_category_no": 27,
"display_order": 0,
"full_category_no": {
"1": "25",
"2": "28",
"3": "30",
"4": "40"
},
"hash_tags": [
"tag1",
"tag2"
]
},
{
"shop_no": 1,
"category_no": 28,
"category_depth": 1,
"parent_category_no": 1,
"category_name": "(large scale classification) Accessories",
"full_category_no": {
"1": "28",
"2": null,
"3": null,
"4": null
},
"full_category_name": {
"1": "(large scale classification) Accessories",
"2": null,
"3": null,
"4": null
},
"display_order": 0,
"hash_tags": [
"tag1",
"tag2"
]
}
]
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품분류 읽기권한 (mall.read_category) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
category_depth 최소: [1]~최대: [4] |
분류 Depth 조회하고자 하는 상품분류의 차수 검색 |
category_no | 분류 번호 조회하고자 하는 상품분류의 번호 |
parent_category_no | 부모 분류 번호 조회하고자 하는 상품분류의 부모 상품분류 번호 검색 |
category_name | 분류명 검색어를 분류명에 포함하고 있는 상품분류 검색(대소문자 구분 없음) |
limit 최대값: [100] |
조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. DEFAULT 10 |
offset 최대값: [8000] |
조회결과 시작위치 조회결과 시작위치 |
Count all categories
Definition
GET 'https://{domain}/api/v2/categories/count'
GET 'https://{mallid}.cafe24api.com/api/v2/categories/count'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/categories/count', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/categories/count' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"count": 3
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품분류 읽기권한 (mall.read_category) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
category_depth 최소: [1]~최대: [4] |
분류 Depth 조회하고자 하는 상품분류의 차수 검색 |
category_no | 분류 번호 조회하고자 하는 상품분류의 번호 |
parent_category_no | 부모 분류 번호 조회하고자 하는 상품분류의 부모 상품분류 번호 검색 |
category_name | 분류명 검색어를 분류명에 포함하고 있는 상품분류 검색(대소문자 구분 없음) |
Get a category
Definition
GET 'https://{domain}/api/v2/categories/{category_no}'
GET 'https://{mallid}.cafe24api.com/api/v2/categories/{category_no}'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/categories/40', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/categories/40' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"category": {
"shop_no": 1,
"category_no": 40,
"category_depth": 4,
"parent_category_no": 37,
"category_name": "(Detailed Category) Cropped",
"full_category_no": {
"1": "25",
"2": "28",
"3": "30",
"4": "40"
},
"full_category_name": {
"1": "(Main Category) Tops",
"2": "(Middle Category) Tees",
"3": "(Small Category) Long Sleeve",
"4": "(Detailed Category) Cropped"
},
"display_order": 0,
"hash_tags": [
"tag1",
"tag2"
]
}
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품분류 읽기권한 (mall.read_category) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
category_noRequired |
분류 번호 조회하고자 하는 상품분류의 번호 |
Categories products
Categories products properties
Attribute | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 |
product_no | 상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
List all categories product
Definition
GET 'https://{domain}/api/v2/categories/{category_no}/products'
GET 'https://{mallid}.cafe24api.com/api/v2/categories/{category_no}/products'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/categories/40/products?display_group=1', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/categories/40/products?display_group=1' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"products": [
{
"shop_no": 1,
"product_no": 10
},
{
"shop_no": 1,
"product_no": 11
},
{
"shop_no": 1,
"product_no": 12
}
]
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 DEFAULT 1 |
category_noRequired |
분류 번호 |
display_groupRequired 최소: [1]~최대: [3] |
상세 상품분류 1 : 일반상품 |
Count all categories products
Definition
GET 'https://{domain}/api/v2/categories/{category_no}/products/count'
GET 'https://{mallid}.cafe24api.com/api/v2/categories/{category_no}/products/count'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/categories/40/products/count?display_group=1', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/categories/40/products/count?display_group=1' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"count": 2
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 DEFAULT 1 |
category_noRequired |
분류 번호 |
display_groupRequired 최소: [1]~최대: [3] |
상세 상품분류 1 : 일반상품 |
Products
상품(Products)은 쇼핑몰에서 판매되는 물건이나 서비스를 의미합니다. 상품은 다양한 색 또는 사이즈의 옵션을 통해 품목으로 쪼개질 수 있습니다.
상품은 다음과 같은 Resource를 하위 Resource로 갖고 있습니다.
● 품목(Variants)
● 상품 메모(Memos)
● SEO(SEO)
● 상품 조회 수(Hits)
Products properties
Attribute | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. |
product_no | 상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
product_code 형식 : [A-Z0-9] |
상품코드 시스템이 상품에 부여한 코드. 해당 쇼핑몰 내에서 상품코드는 중복되지 않음. |
custom_product_code 최대글자수 : [40자] |
자체상품 코드 사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함. |
product_name 최대글자수 : [250자] |
상품명 상품의 이름. 상품명은 상품을 구분하는 가장 기초적인 정보이며 검색 정보가 된다. HTML을 사용하여 입력이 가능하다. |
eng_product_name 최대글자수 : [250자] |
영문 상품명 상품의 영문 이름. 해외 배송 등에 사용 가능함. |
model_name 최대글자수 : [100자] |
모델명 상품의 모델명. |
price | 상품 판매가 상품의 판매 가격. 쿠폰 및 혜택을 적용하기 전의 가격. |
retail_price | 상품 소비자가 시중에 판매되는 소비자 가격. 쇼핑몰의 가격을 강조하기 위한 비교 목적으로 사용함. |
display | 진열상태 상품을 쇼핑몰에 진열할지 여부. 상품을 쇼핑몰에 진열할 경우 설정한 상품분류와 메인화면에 표시된다. 상품이 쇼핑몰에 진열되어 있지 않으면 쇼핑몰 화면에 표시되지 않아 접근할 수 없으며 상품을 구매할 수 없다. T : 진열함 |
selling | 판매상태 상품을 쇼핑몰에 판매할지 여부. 상품을 진열한 상태로 판매를 중지할 경우 상품은 쇼핑몰에 표시되지만 "품절"로 표시되어 상품을 구매할 수 없다. 상품이 "진열안함"일 경우 "판매함" 상태여도 상품에 접근할 수 없기 때문에 구매할 수 없다. T : 판매함 |
product_used_month 최대값: [2147483647] |
중고상품 사용 개월 |
summary_description 최대글자수 : [255자] |
상품요약설명 상품에 대한 요약 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다. |
product_tag 최대글자수 : [200자] |
상품 검색어 검색 또는 분류를 위하여 상품에 입력하는 검색어 정보(해시태그) |
price_content 최대글자수 : [20자] |
판매가 대체문구 상품의 가격 대신 표시되는 문구. 품절이나 상품이 일시적으로 판매 불가할 때 사용. |
buy_unit_type | 구매단위 타입 해당 상품의 구매 단위를 1개 이상으로 설정한 경우 해당 구매 단위를 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 |
buy_unit | 구매단위 구매할 수 있는 최소한의 단위 표시. |
order_quantity_limit_type | 주문수량 제한 기준 해당 상품의 주문 수량 제한시 제한 기준을 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정 P : 상품 기준 |
minimum_quantity 최대값: [2147483647] |
최소 주문수량 주문 가능한 최소한의 주문 수량. 주문 수량 미만으로 구매 할 수 없음. |
maximum_quantity 최대값: [2147483647] |
최대 주문수량 주문 가능한 최대한의 주문 수량. 주문 수량을 초과하여 구매 할 수 없음. |
mileage_amount | 적립금 설정 정보 상품 주문시 받을 수 있는 적립금 금액. 설정에 따라 적립금을 결제수단에 상관 없이 공통적으로 받도록 설정하거나 결제수단별로 받도록 설정할 수 있다. |
adult_certification | 성인인증 성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함. |
detail_image | 상세이미지 상품 상세 화면에 표시되는 상품 이미지. |
list_image | 목록이미지 상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지. |
tiny_image | 작은목록이미지 최근 본 상품 영역에 표시되는 상품의 목록 이미지. |
small_image | 축소이미지 상품 상세 화면 하단에 표시되는 상품 목록 이미지. |
has_option | 옵션 사용여부 해당 상품이 옵션을 갖고 있는지에 대한 여부. 옵션을 갖고 있는 상품은 사이즈나 색상과 같은 다양한 선택지를 제공한다. T : 옵션사용함 |
option_type | 옵션 구성방식 옵션을 사용할 경우, 옵션의 유형 표시 C : 조합 일체선택형 |
manufacturer_code 형식 : [A-Z0-9] |
제조사 코드 제조사를 등록하면 자동으로 생성되는 코드로 상품에 특정 제조사를 지정할 때 사용. |
trend_code 형식 : [A-Z0-9] |
트렌드 코드 트렌드를 등록하면 자동으로 생성되는 코드로 상품에 특정 트렌드를 지정할 때 사용. |
brand_code 형식 : [A-Z0-9] |
브랜드 코드 브랜드를 등록하면 자동으로 생성되는 코드로 상품에 특정 브랜드를 지정할 때 사용. |
made_date | 제조일자 상품을 제조한 제조일자. |
expiration_date 배열 최대사이즈: [2] |
유효기간 상품을 정상적으로 사용할 수 있는 기간. 상품권이나 티켓 같은 무형 상품, 식품이나 화장품 같은 유형 상품의 유효기간을 표시. |
origin_classification | 원산지 국내/국외/기타 F : 국내 |
origin_place_no | 원산지 번호 원산지 번호를 List all Origin API를 통해 원산지를 조회하여 입력 |
origin_place_value 최대글자수 : [30자] |
원산지기타정보 원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보. |
icon_show_period | 아이콘 노출 기간 상품에 설정한 아이콘이 노출되는 기간. |
icon 배열 최대사이즈: [5] |
아이콘 상품에 표시되는 아이콘. 상품 판매를 강조하기 위한 목적으로 사용이 가능함. |
product_material | 상품소재 상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%) |
list_icon | 추천 / 품절 / 신상품 아이콘 노출 여부 추천, 품절, 신상품 아이콘을 목록에서 표시하는지 여부 |
select_one_by_option | 옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 |
approve_status | 승인요청 결과 N : 승인요청 (신규상품) |
sold_out | 품절여부 T : 품절 |
discountprice | 상품 할인판매가 리소스
|
decorationimages | 꾸미기 이미지 리소스
|
benefits | 혜택 리소스
|
variants | 품목 리소스
상세 조회시에만 확인 가능하다. |
memos | 메모 리소스
상세 조회시에만 확인 가능하다. |
hits | 상품 조회수 Resource
상세 조회시에만 확인 가능하다. |
seo | 상품 Seo Resource
상세 조회시에만 확인 가능하다. |
category | 분류 번호 해당 상품이 진열되어있는 상품 분류. 상세 조회시에만 확인 가능하다. |
description | 상품상세설명 상품에 보다 상세한 정보가 포함되어있는 설명. HTML을 사용하여 입력이 가능하다. 상세 조회시에만 확인 가능하다. |
mobile_description | 모바일 상품 상세설명 입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함. 상세 조회시에만 확인 가능하다. |
additional_image 배열 최대사이즈: [20] |
추가이미지 상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다. 상세 조회시에만 확인 가능하다. |
payment_info | 상품결제안내 상품의 결제 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다. 상세 조회시에만 확인 가능하다. |
shipping_info | 상품배송안내 상품의 배송 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다. 상세 조회시에만 확인 가능하다. |
exchange_info | 교환/반품안내 상품의 교환/반품 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다. 상세 조회시에만 확인 가능하다. |
service_info | 서비스문의/안내 제품의 사후 고객 서비스 방법 대한 안내 문구. HTML을 사용하여 입력이 가능하다. 상세 조회시에만 확인 가능하다. |
product_tax_type_text | 부가세 표시 문구 상품관리 > 상품표시관리 > 상품정보표시 설정 > 판매가 부가세 표시 문구에서 설정한 문구 표시 상세 조회시에만 확인 가능하다. |
set_product_type | 세트상품 타입 상세 조회시에만 확인 가능하다. C : 일반세트 |
simple_description | 상품 간략 설명 상품에 대한 간략한 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다. 상세 조회시에만 확인 가능하다. |
tags | 상품 태그 리소스
상세 조회시에만 확인 가능하다. |
options | 상품 옵션 리소스
상세 조회시에만 확인 가능하다. |
shipping_method | 배송방법 (개별배송비를 사용할 경우) 배송 수단 및 방법 상세 조회시에만 확인 가능하다. 01 : 택배 |
prepaid_shipping_fee | 배송비 선결제 설정 상세 조회시에만 확인 가능하다. C : 착불 |
shipping_period | 배송기간 (개별배송비를 사용할 경우) 상품 배송시 평균적으로 소요되는 배송 기간. 상세 조회시에만 확인 가능하다. |
shipping_scope | 배송정보 국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. 상점관리 > 배송관리 > 배송/반품 설정에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가. 상세 조회시에만 확인 가능하다. A : 국내배송 |
shipping_area 최대글자수 : [255자] |
배송지역 (개별배송비를 사용할 경우) 상품을 배송할 수 있는 지역. 상세 조회시에만 확인 가능하다. |
shipping_fee_type | 배송비 타입 (개별배송비를 사용할 경우) 상품의 배송비 타입. 상세 조회시에만 확인 가능하다. T : 배송비 무료 |
shipping_rates | 구간별 배송비 개별배송비를 사용할 경우 상품의 개별 배송비. 상세 조회시에만 확인 가능하다. |
clearance_category_code 형식 : [A-Z0-9] |
해외통관코드 상세 조회시에만 확인 가능하다. |
origin_place_code | 원산지 코드 상품의 원산지 코드. 상세 조회시에만 확인 가능하다. |
additional_information | 추가항목 상품관리 > 상품표시관리 > 상품정보표시 설정에서 추가한 추가항목. 상세 조회시에만 확인 가능하다. |
main | 메인진열 상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다. 상세 조회시에만 확인 가능하다. |
relational_product | 관련상품 해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다. 상세 조회시에만 확인 가능하다. |
List all products
Definition
GET 'https://{domain}/api/v2/products'
GET 'https://{mallid}.cafe24api.com/api/v2/products'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"products": [
{
"shop_no": 1,
"product_no": 24,
"product_code": "P000000X",
"custom_product_code": "",
"product_name": "iPhone X",
"eng_product_name": "iPhone Ten",
"model_name": "A1865",
"price": "1000.00",
"retail_price": "0.00",
"display": "T",
"selling": "F",
"product_used_month": 2,
"summary_description": "This is Product Summary.",
"price_content": null,
"buy_unit_type": "O",
"buy_unit": 1,
"order_quantity_limit_type": "O",
"minimum_quantity": 1,
"maximum_quantity": 0,
"mileage_amount": null,
"adult_certification": "F",
"detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
"list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
"tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
"small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
"has_option": "F",
"option_type": "T",
"manufacturer_code": "M0000000",
"trend_code": "T0000000",
"brand_code": "B0000000",
"made_date": "",
"expiration_date": {
"start_date": "20170908",
"end_date": "20170914"
},
"origin_classification": "F",
"origin_place_no": 1798,
"origin_place_value": "",
"icon_show_period": {
"start_date": "2017-10-30 09:00:00",
"end_date": "2017-11-02 16:00:00"
},
"icon": [
"icon_01_01",
"icon_02_01"
],
"product_material": "",
"list_icon": {
"soldout_icon": true,
"recommend_icon": false,
"new_icon": false
},
"approve_status": "",
"sold_out": "F"
},
{
"shop_no": 1,
"product_no": 23,
"product_code": "P000000W",
"custom_product_code": "",
"product_name": "iPhone X",
"eng_product_name": "iPhone Ten",
"model_name": "A1865",
"price": 1000,
"retail_price": 0,
"display": "T",
"selling": "F",
"product_used_month": 2,
"summary_description": "This is Product Summary.",
"price_content": null,
"buy_unit_type": "O",
"buy_unit": 1,
"order_quantity_limit_type": "O",
"minimum_quantity": 1,
"maximum_quantity": 0,
"mileage_amount": null,
"adult_certification": "F",
"detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
"list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
"tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
"small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
"has_option": "F",
"option_type": "T",
"manufacturer_code": "M0000000",
"trend_code": "T0000000",
"brand_code": "B0000000",
"made_date": "",
"expiration_date": {
"start_date": "20170908",
"end_date": "20170914"
},
"origin_classification": "F",
"origin_place_no": 1798,
"origin_place_value": "",
"icon_show_period": {
"start_date": "2017-10-30 09:00:00",
"end_date": "2017-11-02 16:00:00"
},
"icon": [
"icon_01_01",
"icon_02_01"
],
"product_material": "",
"list_icon": {
"soldout_icon": true,
"recommend_icon": false,
"new_icon": false
},
"approve_status": "C",
"sold_out": "F"
}
]
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
discountpriceembed |
상품 할인판매가 리소스
|
decorationimagesembed |
꾸미기 이미지 리소스
|
benefitsembed |
혜택 리소스
|
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 | 자체상품 코드 검색어를 자체상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요) ,(콤마)로 여러 건을 검색할 수 있다. |
price_min | 상품 판매가 검색 최소값 판매가가 해당 범위 이상인 상품 검색 |
price_max | 상품 판매가 검색 최대값 판매가가 해당 범위 이하인 상품 검색 |
retail_price_min 최소값: [0] |
상품 소비자가 검색 최소값 소비자가가 해당 범위 이상인 상품 검색 |
retail_price_max 최소값: [0] |
상품 소비자가 검색 최대값 소비자가가 해당 범위 이하인 상품 검색 |
supply_price_min | 상품 공급가 검색 최소값 공급가가 해당 범위 이하인 상품 검색 |
supply_price_max | 상품 공급가 검색 최대값 공급가가 해당 범위 이상인 상품 검색 |
created_start_date timezone |
상품 등록일 검색 시작일 상품 등록일이 해당 날짜 이후인 상품 검색. |
created_end_date timezone |
상품 등록일 검색 종료일 상품 등록일이 해당 날짜 이전인 상품 검색. |
updated_start_date timezone |
상품 수정일 검색 시작일 상품 수정일이 해당 날짜 이후인 상품 검색. |
updated_end_date timezone |
상품 수정일 검색 종료일 상품 수정일이 해당 날짜 이전인 상품 검색. |
category | 분류 번호 특정 분류에 진열된 상품 검색. |
eng_product_name | 영문 상품명 검색어를 영문 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다. |
supply_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 : 사용함 |
category_unapplied | 미적용 분류 검색 분류가 등록되지 않은 상품에 대하여 검색함. T: 미적용 분류 검색 |
include_sub_category | 하위분류 포함 검색 하위분류에 등록된 상품을 포함하여 검색함. T: 포함 |
additional_information_key | 추가항목 검색조건 키 추가항목에 대하여 검색하기 위한 키. 검색을 위해선 key 와 value 모두 필요함. |
additional_information_value | 추가항목 검색조건 값 추가항목에 대하여 검색하기 위한 키의 값. 검색을 위해선 key 와 value 모두 필요함. |
approve_status | 승인상태 검색 N : 승인요청 (신규상품) 상태값 |
since_product_no 최소값: [1] |
해당 상품번호 이후 검색 특정 상품번호 이후의 상품들을 검색. 해당 검색조건 사용시 offset과 관계 없이 모든 상품을 검색할 수 있다. |
sort | 정렬 순서 값 created_date : 등록일 |
order | 정렬 순서 asc : 순차정렬 |
offset 최대값: [5000] |
조회결과 시작위치 조회결과 시작위치 |
limit 최대값: [100] |
조회결과 최대건수 조회하고자 하는 최대 건수를 지정할 수 있음. DEFAULT 10 |
Count all products
Definition
GET 'https://{domain}/api/v2/products/count'
GET 'https://{mallid}.cafe24api.com/api/v2/products/count'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/count', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/count' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"count": 2
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
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 | 자체상품 코드 검색어를 자체상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요) ,(콤마)로 여러 건을 검색할 수 있다. |
price_min | 상품 판매가 검색 최소값 판매가가 해당 범위 이상인 상품 검색 |
price_max | 상품 판매가 검색 최대값 판매가가 해당 범위 이하인 상품 검색 |
retail_price_min 최소값: [0] |
상품 소비자가 검색 최소값 소비자가가 해당 범위 이상인 상품 검색 |
retail_price_max 최소값: [0] |
상품 소비자가 검색 최대값 소비자가가 해당 범위 이하인 상품 검색 |
supply_price_min | 상품 공급가 검색 최소값 공급가가 해당 범위 이하인 상품 검색 |
supply_price_max | 상품 공급가 검색 최대값 공급가가 해당 범위 이상인 상품 검색 |
created_start_date timezone |
상품 등록일 검색 시작일 상품 등록일이 해당 날짜 이후인 상품 검색. |
created_end_date timezone |
상품 등록일 검색 종료일 상품 등록일이 해당 날짜 이전인 상품 검색. |
updated_start_date timezone |
상품 수정일 검색 시작일 상품 수정일이 해당 날짜 이후인 상품 검색. |
updated_end_date timezone |
상품 수정일 검색 종료일 상품 수정일이 해당 날짜 이전인 상품 검색. |
category | 분류 번호 특정 분류에 진열된 상품 검색. |
eng_product_name | 영문 상품명 검색어를 영문 상품명에 포함하고 있는 상품 검색(대소문자 구분 없음) ,(콤마)로 여러 건을 검색할 수 있다. |
supply_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 : 사용함 |
category_unapplied | 미적용 분류 검색 분류가 등록되지 않은 상품에 대하여 검색함. T: 미적용 분류 검색 |
include_sub_category | 하위분류 포함 검색 하위분류에 등록된 상품을 포함하여 검색함. T: 포함 |
additional_information_key | 추가항목 검색조건 키 추가항목에 대하여 검색하기 위한 키. 검색을 위해선 key 와 value 모두 필요함. |
additional_information_value | 추가항목 검색조건 값 추가항목에 대하여 검색하기 위한 키의 값. 검색을 위해선 key 와 value 모두 필요함. |
approve_status | 승인상태 검색 N : 승인요청 (신규상품) 상태값 |
since_product_no 최소값: [1] |
해당 상품번호 이후 검색 특정 상품번호 이후의 상품들을 검색. 해당 검색조건 사용시 offset과 관계 없이 모든 상품을 검색할 수 있다. |
Get a product
Definition
GET 'https://{domain}/api/v2/products/{product_no}'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/20', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/20' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"product": {
"shop_no": 1,
"product_no": 20,
"category": [
{
"category_no": 27,
"recommend": "F",
"new": "T"
},
{
"category_no": 28,
"recommend": "T",
"new": "F"
}
],
"product_code": "P000000T",
"custom_product_code": "",
"product_name": "iPhone X",
"eng_product_name": "iPhone Ten",
"model_name": "A1865",
"price": "1000.00",
"retail_price": "0.00",
"display": "T",
"description": "Sample Description.",
"mobile_description": "Sample Mobile Description.",
"additional_image": [
{
"big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
"medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
"small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg"
},
{
"big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
"medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
"small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/e1ab68969d69287a828438c7684b14c4.jpg"
}
],
"payment_info": "Sample payment info. You have to Pay.",
"shipping_info": "Sample shipping info. You have to ship.",
"exchange_info": "Sample exchange info. You have to exchange.",
"service_info": "Sample service info. You have to service.",
"product_tax_type_text": null,
"set_product_type": null,
"selling": "F",
"product_used_month": 2,
"simple_description": "This is Product Description.",
"summary_description": "This is Product Summary.",
"product_tag": "edu,test,sample",
"price_content": null,
"buy_unit_type": "O",
"buy_unit": 1,
"order_quantity_limit_type": "O",
"minimum_quantity": 1,
"maximum_quantity": 0,
"mileage_amount": null,
"adult_certification": "F",
"detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
"list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
"tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
"small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
"has_option": "F",
"option_type": "T",
"manufacturer_code": "M0000000",
"trend_code": "T0000000",
"brand_code": "B0000000",
"made_date": "",
"expiration_date": {
"start_date": "20170908",
"end_date": "20170914"
},
"origin_classification": "F",
"origin_place_no": 1798,
"origin_place_value": "",
"icon_show_period": {
"start_date": "2017-10-30 09:00:00",
"end_date": "2017-11-02 16:00:00"
},
"icon": null,
"product_material": "",
"shipping_method": "01",
"prepaid_shipping_fee": "B",
"shipping_period": {
"minimum": 3,
"maximum": 7
},
"shipping_scope": "A",
"shipping_area": "All around World",
"shipping_fee_type": "W",
"shipping_rates": [
{
"shipping_rates_min": "0.00",
"shipping_rates_max": "1.00",
"shipping_fee": "100.00"
},
{
"shipping_rates_min": "1.00",
"shipping_rates_max": "2.00",
"shipping_fee": "200.00"
}
],
"clearance_category_code": "ACAB0000",
"origin_place_code": 1798,
"list_icon": {
"soldout_icon": true,
"recommend_icon": true,
"new_icon": true
},
"additional_information": [
{
"key": "custom_option1",
"name": "gift option",
"value": "Yes"
}
],
"main": [
3,
2
],
"relational_product": [
{
"product_no": 17,
"interrelated": "T"
},
{
"product_no": 19,
"interrelated": "F"
}
],
"select_one_by_option": "F",
"approve_status": "C",
"sold_out": "F"
}
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
product_noRequired |
상품번호 조회하고자 하는 상품의 번호 |
variantsembed |
품목 리소스
|
memosembed |
메모 리소스
|
hitsembed |
상품 조회수 Resource
|
seoembed |
상품 Seo Resource
|
tagsembed |
상품 태그 리소스
|
optionsembed |
상품 옵션 리소스
|
discountpriceembed |
상품 할인판매가 리소스
|
decorationimagesembed |
꾸미기 이미지 리소스
|
benefitsembed |
혜택 리소스
|
Products cart
상품 장바구니는 상품별로 고객이 장바구니에 얼마나 많은 상품을 담았는지 확인할 수 있는 정보입니다. 상품 장바구니 API로 상품이 얼마나 고객의 장바구니에 많이 담겨있는지 확인 가능합니다.
Products cart properties
Count all products cart
Definition
GET 'https://{domain}/api/v2/products/{product_no}/cart/count'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/cart/count'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/11/cart/count', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/11/cart/count' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"count": 7
}
기본스펙
Property | Description |
---|---|
SCOPE | 개인화정보 읽기권한 (mall.read_personal) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
product_noRequired |
상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다. |
Products decorationimages
Products decorationimages properties
Attribute | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 |
use_show_date | 표시기간 사용 여부 T : 사용함 |
show_start_date timezone |
표시기간 시작 일자 |
show_end_date timezone |
표시기간 종료 일자 |
image_list | 꾸미기 이미지 리스트 |
List all products decoration images
Definition
GET 'https://{domain}/api/v2/products/{product_no}/decorationimages'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/decorationimages'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/20/decorationimages', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/20/decorationimages' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"decorationimage": {
"use_show_date": "T",
"show_start_date": "2017-10-30T09:00:00+09:00",
"show_end_date": "2017-11-02T16:00:00+09:00",
"image_list": [
{
"code": "image_custom_4",
"path": "http:\/\/{domain}\/web\/upload\/image_custom_415421761806290.gif",
"image_vertical_position": "L",
"image_horizontal_position": "T"
},
{
"code": "image_custom_3",
"path": "http:\/\/{domain}\/web\/upload\/image_custom_615421761805558.gif",
"image_vertical_position": "C",
"image_horizontal_position": "B"
}
]
}
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 DEFAULT 1 |
product_noRequired |
상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
Products discountprice
Products discountprice properties
Attribute | Description |
---|---|
pc_discount_price | PC 할인 판매가 |
mobile_discount_price | 모바일 할인 판매가 |
List all products discountprice
Definition
GET 'https://{domain}/api/v2/products/{product_no}/discountprice'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/discountprice'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/24/discountprice', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/24/discountprice' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"discountprice": {
"pc_discount_price": "7000.00",
"mobile_discount_price": "6000.00"
}
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 DEFAULT 1 |
product_noRequired |
상품번호 |
Products hits
상품 조회수(Hits)는 상품을 쇼핑몰 고객들이 얼마나 조회했는지를 나타내는 지표입니다. 상품 조회수를 확인하여 고객들이 어떤 상품을 가장 많이 조회하는지 알 수 있습니다.
상품 조회수는 하위 Resource로서 상품(Products) 하위에서만 사용할 수 있습니다.
Products hits properties
Count all products hits
Definition
GET 'https://{domain}/api/v2/products/{product_no}/hits/count'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/hits/count'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/7/hits/count', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/7/hits/count' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"count": 3
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
product_noRequired |
상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다. |
Products icons
상품 아이콘은 상품을 강조하기 위해 상품 옆에 추가할 수 있는 작은 이미지들입니다. 진열된 상품에 할인 정보, "매진 임박" 등의 메시지를 추가하여 상품을 강조할 수 있습니다.
상품 아이콘는 하위 Resource로서 상품(Products) 하위에서만 사용할 수 있습니다.
Products icons properties
Attribute | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 |
use_show_date | 표시기간 사용 여부 T : 사용함 |
show_start_date timezone |
표시기간 시작 일자 |
show_end_date timezone |
표시기간 종료 일자 |
image_list | 상품 아이콘 리스트 |
List all products icons
Definition
GET 'https://{domain}/api/v2/products/{product_no}/icons'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/icons'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/20/icons', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/20/icons' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"icons": {
"shop_no": 1,
"use_show_date": "T",
"show_start_date": "2017-10-30T09:00:00+09:00",
"show_end_date": "2017-11-02T16:00:00+09:00",
"image_list": [
{
"code": "custom_1",
"path": "http:\/\/{domain}\/web\/upload\/custom_1.gif"
},
{
"code": "custom_2",
"path": "http:\/\/{domain}\/web\/upload\/custom_2.gif"
}
]
}
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 DEFAULT 1 |
product_noRequired |
상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
Products options
Products options properties
Attribute | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. |
product_no Required |
상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
has_option | 옵션 사용여부 T : 사용함 |
option_type | 옵션 구성방식 옵션을 사용할 경우, 옵션의 유형 표시 T : 조합형 |
option_list_type | 옵션 표시방식 조합형 옵션을 사용할 경우, 조합형 옵션의 유형 표시 C : 일체형 |
option | 옵션 해당 상품의 옵션명과 옵션값 표시 |
select_one_by_option | 옵션별로 한 개씩 선택 (독립형 옵션) 독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함. T : 사용함 |
use_additional_option | 추가입력 옵션 사용여부 T : 사용함 |
additional_option | 추가입력 옵션 |
use_attached_file_option | 파일 첨부 옵션 사용여부 T : 사용함 |
attached_file_option | 파일 첨부 옵션 |
List all products options
Definition
GET 'https://{domain}/api/v2/products/{product_no}/options'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/options'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/7/options', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/7/options' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"options": {
"shop_no": 1,
"product_no": 7,
"has_option": "T",
"option_type": "E",
"option_display_type": "S",
"option": [
{
"option_code": "O000000A",
"option_name": "Color",
"option_value": [
{
"option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
"option_color": "#000000",
"option_text": "Black"
},
{
"option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
"option_color": "#007543",
"option_text": "Red"
}
],
"required_option": "T",
"option_display_type": "S"
},
{
"option_code": "O000000B",
"option_name": "Size",
"option_value": [
{
"option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
"option_color": "#000000",
"option_text": "Small"
},
{
"option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
"option_color": "#007543",
"option_text": "Large"
}
],
"required_option": "T",
"option_display_type": "S"
}
],
"select_one_by_option": "F",
"use_additional_option": "T",
"additional_option": [
{
"additional_option_name": "Pattern",
"required_additional_option": "T",
"additional_option_text_length": 20
},
{
"additional_option_name": "Custom Option",
"required_additional_option": "F",
"additional_option_text_length": 10
}
],
"use_attached_file_option": "T",
"attached_file_option": {
"option_name": "Pattern Images",
"required": "T",
"size_limit": 3
}
}
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
product_noRequired |
상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
Products variants
품목(Variants)은 쇼핑몰에서 판매되는 상품의 기본 단위입니다. 쇼핑몰은 일반적으로 고객에게 다양한 선택권을 제공하기 위해 같은 상품이지만 사이즈가 다르거나, 혹은 색상이 다른 품목들을 판매합니다.
품목은 다음과 같은 Resource를 하위 Resource로 갖고 있습니다.
● 재고(Inventories)
Products variants properties
Attribute | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. |
variant_code 형식 : [A-Z0-9] |
품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않음. |
option | 옵션 품목의 옵션. 해당 품목이 어떤 옵션으로 이루어져있는지를 나타낸다. 고객이 상품 구매시 해당 옵션을 선택할 경우 현재 품목을 구매할 수 있다. |
display | 진열상태 해당 품목을 진열할지 여부. 품목을 진열할 경우 상품 상세 또는 상품 목록에서 해당 품목을 선택할 수 있다. 품목이 진열되어있지 않을 경우 해당 품목이 표시되지 않으며 해당 품목을 구매할 수 없다. T : 진열함 |
selling | 판매상태 해당 품목을 판매할지 여부. 진열은 되어있으나 판매는 하지 않을 경우 해당 품목은 "품절"로 표시되며 해당 품목을 구매할 수 없다. 품목이 "판매함" 상태여도 "진열안함"으로 되어있다면 해당 품목을 구매할 수 없다. T : 판매함 |
additional_amount | 추가금액 해당 품목을 구매할 경우, 상품의 판매가에 더하여 지불해야하는 추가 가격. |
inventories | 재고 리소스 품목의 재고 Resource |
List all products variants
Definition
GET 'https://{domain}/api/v2/products/{product_no}/variants'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/variants'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/20/variants', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/20/variants' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"variants": [
{
"shop_no": 1,
"variant_code": "P000000R000C",
"option": [
{
"name": "Color",
"value": "Blue"
},
{
"name": "Size",
"value": "Small"
}
],
"display": "T",
"selling": "T",
"additional_amount": "0.00"
},
{
"shop_no": 1,
"variant_code": "P000000R000D",
"option": [
{
"name": "Color",
"value": "Red"
},
{
"name": "Size",
"value": "Small"
}
],
"display": "T",
"selling": "T",
"additional_amount": "0.00"
}
]
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
product_noRequired |
상품번호 시스템에서 부여한 상품의 번호. 상품 번호는 쇼핑몰 내에서 중복되지 않는다. |
Get a products variant
Definition
GET 'https://{domain}/api/v2/products/{product_no}/variants/{variant_code}'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/variants/{variant_code}'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/20/variants/P000000R000C', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/20/variants/P000000R000C' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"variant": {
"shop_no": 1,
"variant_code": "P000000R000C",
"option": [
{
"name": "Color",
"value": "Black"
}
],
"display": "T",
"selling": "T",
"additional_amount": "0.00"
}
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
product_noRequired |
상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
variant_codeRequired 형식 : [A-Z0-9] |
품목코드 |
inventoriesembed |
재고 리소스
|
Products variants inventories
재고(Inventories)는 판매 가능한 해당 품목의 수량을 의미합니다. 재고는 품목(Variants)별로 존재하며 해당 재고 이상 품목이 판매되면 해당 상품은 품절 상태가 됩니다.
Products variants inventories properties
Attribute | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. |
variant_code 형식 : [A-Z0-9] |
품목코드 시스템이 품목에 부여한 코드. 해당 쇼핑몰 내에서 품목 코드는 중복되지 않는다. |
quantity | 수량 해당 품목에 판매가 가능한 재고 수량. 재고 수량은 주문 또는 결제시 차감되며, 품절 표시를 위하여 체크된다. |
List all products variants inventory
Definition
GET 'https://{domain}/api/v2/products/{product_no}/variants/{variant_code}/inventories'
GET 'https://{mallid}.cafe24api.com/api/v2/products/{product_no}/variants/{variant_code}/inventories'
Request example:
CAFE24API.init('BrIfqEKoP.......'); //client_id
CAFE24API.get('/api/v2/products/20/variants/P000000R000C/inventories', function(err, res){
console.log(res);
});
curl -X GET \
'https://{mallid}.cafe24api.com/api/v2/products/20/variants/P000000R000C/inventories' \
-H 'X-Cafe24-Client-Id: {client_id}' \
-H 'Content-Type: application/json'
Response example:
{
"inventory": {
"shop_no": 1,
"variant_code": "P000000R000C",
"quantity": 0
}
}
기본스펙
Property | Description |
---|---|
SCOPE | 상품 읽기권한 (mall.read_product) |
호출건수 제한 | 30 |
요청사양
Parameter | Description |
---|---|
shop_no | 멀티쇼핑몰 번호 멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호. DEFAULT 1 |
product_noRequired |
상품번호 상품의 고유한 일련 번호. 해당 쇼핑몰 내에서 상품 번호는 중복되지 않음. |
variant_codeRequired 형식 : [A-Z0-9] |
품목코드 판매 수량을 검색할 품목 코드 |