NAV Navbar
shell
  • Introduction
  • Authentication
  • Appstore orders
  • Appstore payments
  • Brands
  • Categories
  • Classifications
  • Coupons
  • Coupons issue
  • Currency
  • Customergroup
  • Customers
  • Customers memos
  • Customers reviews
  • Customersprivacy
  • Dashboard
  • Mains
  • Mains products
  • Manufacturers
  • Mileage
  • Orders
  • Orders buyer
  • Orders items
  • Orders receivers
  • Origin
  • Products
  • Products approve
  • Products cart
  • Products decorationimages
  • Products discountprice
  • Products hits
  • Products icons
  • Products images
  • Products memos
  • Products options
  • Products seo
  • Products tags
  • Products variants
  • Products variants inventories
  • Reports salesvolume
  • Reviews
  • Reviews comments
  • Scripttags
  • Shops
  • Sms
  • Sms senders
  • Store
  • Suppliers
  • Suppliers users
  • Themes
  • Trends
  • Users
  • Codes
  • 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": {
            }
        }
    }
    

    Method

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

    Admin API Intro

    사용 예시

    https://{mallid}.cafe24api.com/api/v2/admin/sampleapi
    

    Admin API

    Admin API는 쇼핑몰 관리자가 쇼핑몰의 정보를 조회하거나 생성, 수정, 삭제하는데 적합합니다. Admin API는 해당 Entity의 정보를 대부분 조회할 수 있으며 OAuth 2.0 방식의 별도 인증을 통과한 경우에만 사용할 수 있습니다.

    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?embed=variants,inventories
    

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

    1. 검색조건을 추가하기

    API 조회시 검색조건은 엔드포인트에 파라메터를 추가하여 검색할 수 있습니다. 여러 조건을 같이 검색할 경우 "&" 구분자를 이용하여 검색 조건을 추가할 수 있습니다.

    시작일, 종료일 등 범위를 검색할 경우에도 "&" 구분자를 사용하여 검색할 수 있습니다.

    2. 파라메터에서 여러조건 검색하기

    API에서 지원하는 경우, 콤마(,)를 사용하여 여러 값을 동시에 검색할 수 있습니다.

    콤마(,)로 추가한 검색 조건은 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 호출을 할 수 있습니다.

    Header에 X-Api-Call-Limit을 확인하면 429 에러를 피할 수 있습니다. 해당 쇼핑몰에서 얼마나 API를 호출했는지, 그리고 Bucket 여유량은 얼마나 남았는지를 확인할 수 있습니다.

    Authentication

    Get Authentication Code

    토큰발급 요청시 사용된 code는 재사용할 수 없으며 코드 발급 후 1분이 경과하면 만료됩니다.

    예시 코드 (요청)

    GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}'
    

    예시 코드 (응답)

    HTTP/1.1 302 Found
    Location: {redirect_uri}?code={authorize_code}&state={state}
    

    접근 토큰을 발급 받으려면 면저 접근 코드를 요청해야 합니다. 접근 코드는 클라이언트가 웹 애플리케이션 형태일 경우 이용됩니다. 코드 요청은 cURL이 아닌 웹브라우저에서 진행하셔야 합니다.

    자세히보기

    Get Access Token

    발급 받은 인증 코드를 사용하여 실제로 API를 호출할 수 있는 사용자 토큰(Access Token, Refresh Token)을 받아 올 수 있습니다.

    예시 코드 (요청)

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/oauth/token' \
      -H 'Authorization: Basic {base64_encode({client_id}:{client_secret})}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -d 'grant_type=authorization_code' \
      -d 'code={code}' \
      -d 'redirect_uri={redirect_uri}'
    

    예시 코드 (응답)

    HTTP/1.1 200 OK
    {
        "access_token": "0iqR5nM5EJIq.......",
        "expires_at": "2017-10-19T19:17:57.902",
        "refresh_token": "Cuq6H1WLKBxqqf.......",
        "client_id": "BrIfqEKoP.......",
        "mall_id": "yourmall",
        "user_id": "test",
        "scopes": [
            "mall.read_order",
            "mall.read_product",
            "mall.read_store",
            "...etc...",
        ],
        "issued_at": "2017-10-19T17:17:57.911"
    }
    

    access_token : 접근 토큰으로서 클라이언트가 리소스 서버에 접근시 사용됩니다.

    refresh_token : 접근 토큰 만료 후 재발급을 위해 사용하는 토큰입니다.

    자세히보기

    Get Access Token using refresh token

    접근 토큰은 발급 받은 후 2시간이 지나면 사용할 수 없습니다. 접근 토큰이 만료된 후 다시 재발급을 받아야 리소스 서버에 접근할 수 있습니다. 이미 접근 토큰을 발급 받았다면 refresh_token를 사용하여 접근 토큰을 재발급 받을수 있습니다.

    refresh token은 2주간 유효하며, refresh token 만료전에 요청을 하면 갱신된 access token과 갱신된 refresh token이 함께 반환됩니다. 기존 refresh token은 만료처리되어 사용할 수 없습니다.

    발급 받은 인증 코드를 사용하여 실제로 API를 호출할 수 있는 사용자 토큰(Access Token, Refresh Token)을 받아 올 수 있습니다.

    예시 코드 (요청)

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/oauth/token' \
      -H 'Authorization: Basic {base64_encode({client_id}:{client_secret})}' \
      -H 'Content-Type: application/x-www-form-urlencoded' \
      -d 'grant_type=refresh_token' \
      -d 'refresh_token={refresh_token}'
    

    예시 코드 (응답)

    HTTP/1.1 200 OK
    {
        "access_token": "0iqR5nM5EJIq.......",
        "expires_at": "2017-10-19T19:17:57.902",
        "refresh_token": "Cuq6H1WLKBxqqf.......",
        "client_id": "BrIfqEKoP.......",
        "mall_id": "yourmall",
        "user_id": "test",
        "scopes": [
            "mall.read_order",
            "mall.read_product",
            "mall.read_store",
            "...etc...",
        ],
        "issued_at": "2017-10-19T17:17:57.911"
    }
    

    access_token : 접근 토큰으로서 클라이언트가 리소스 서버에 접근시 사용됩니다.

    refresh_token : 접근 토큰 만료 후 재발급을 위해 사용하는 토큰입니다.

    자세히보기

    Appstore orders

    앱스토어 주문 생성 API를 통해 쇼핑몰 운영자에게 결제 필요한 금액을 부과하기 위해 앱스토어 주문을 생성할 수 있습니다.

    Appstore orders properties

    Attribute Description
    order_id

    주문아이디

    앱스토어 주문의 주문 ID

    order_name

    주문명

    앱스토어 주문의 주문 이름. 주문 생성시 지정이 가능하며, 사용자가 결제시 해당 결제의 내용이 무엇인지 알 수 있는 내용이어야 함.

    order_amount

    주문금액

    앱스토어 주문 생성시 결제 요청한 주문 금액

    return_url

    Return Url

    사용자가 결제 후 이동해야하는 페이지.

    automatic_payment

    최대글자수 : [1자]

    정기과금 여부

    T : 사용함
    F : 사용안함

    created_date

    timezone

    주문 생성일

    상세 조회시에만 확인 가능하다.

    confirmation_url

    결제 Url

    사용자가 결제하기 위해 자동으로 이동하는 페이지 주소

    Get an appstore order

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/appstore/orders/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/appstore/orders/cafe24-20180704-100000000' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "order": {
            "order_id": "cafe24-20180704-100000000",
            "order_name": "App Name_Appstore Order Name",
            "order_amount": "1000.00",
            "return_url": "https:\/\/sample_shop.cafe24.com",
            "automatic_payment": "F",
            "created_date": "2018-07-04T13:52:49+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 앱 읽기권한 (READ_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    order_id
    Required

    주문번호

    조회하고자하는 앱스토어 주문 번호

    Create an appstore order

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/appstore/orders'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/appstore/orders' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "order_name": "Appstore Order Name",
            "order_amount": "1000.00",
            "return_url": "https:\/\/sample_shop.cafe24.com",
            "automatic_payment": "F"
        }
    }'
    

    Response example:

    {
        "order": {
            "order_id": "cafe24-20180704-100000000",
            "order_name": "Appstore Order Name",
            "order_amount": "1000.00",
            "return_url": "https:\/\/sample_shop.cafe24.com",
            "automatic_payment": "F",
            "confirmation_url": "https:\/\/samplemall.cafe24.com\/disp\/common\/myapps\/order?signature=BAhpBBMxojw%3D--d1c0134218f0ff3c0f57cb3b57bcc34e6f170727"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 앱 쓰기권한 (WRITE_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    order_name
    Required

    최대글자수 : [100자]

    주문명

    앱스토어 주문의 주문 이름. 주문 생성시 지정이 가능하며, 사용자가 결제시 해당 결제의 내용이 무엇인지 알 수 있는 내용이어야 함.

    order_amount
    Required

    주문금액

    사용자에게 결제 받고자 하는 주문 금액 입력

    return_url
    Required

    최대글자수 : [250자]

    Return Url

    사용자가 결제 후 이동해야하는 페이지. 결제 완료 페이지 주소를 입력한다.

    automatic_payment

    최대글자수 : [1자]

    정기과금 여부

    T : 사용함
    F : 사용안함

    DEFAULT F

    Appstore payments

    앱스토어 주문을 결제 완료한 경우 앱스토어 결제 조회를 통해 결제 내역을 확인할 수 있습니다.

    Appstore payments properties

    Attribute Description
    order_id

    결제번호

    앱스토어 주문의 주문 ID

    title

    결제 명

    앱스토어 주문의 주문 이름. 주문 생성시 지정이 가능하며, 사용자가 결제시 해당 결제의 내용이 무엇인지 알 수 있는 내용이어야 함.

    approval_no

    승인번호

    결제 승인 번호

    payment_gateway_name

    결제 PG사 이름

    payment_method

    결제수단

    payment_amount

    결제금액

    currency

    화폐단위

    locale_code

    결제국가

    pay_date

    timezone

    결제승인일

    List all appstore payments

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/appstore/payments'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/appstore/payments?start_date=2018-04-06&end_date=2018-07-05' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "payments": [
            {
                "order_id": "cafe24-20180704-100000000",
                "title": "App Name_App Store Order1",
                "approval_no": "10000000",
                "payment_gateway_name": "allat",
                "payment_method": "card",
                "payment_amount": "1000.00",
                "currency": "KRW",
                "locale_code": "ko_KR",
                "pay_date": "2018-07-04T11:19:27+09:00"
            },
            {
                "order_id": "cafe24-20180704-200000000",
                "title": "App Name_App Store Order2",
                "approval_no": "20000000",
                "payment_gateway_name": "allat",
                "payment_method": "card",
                "payment_amount": "1000.00",
                "currency": "KRW",
                "locale_code": "ko_KR",
                "pay_date": "2018-07-04T11:19:27+09:00"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 앱 읽기권한 (READ_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    order_id

    주문번호

    조회하고자하는 앱스토어 주문 번호

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

    start_date
    Required

    날짜
    timezone

    검색 시작일

    해당일 이후에 결제완료된 주문 검색

    end_date
    Required

    날짜
    timezone

    검색 종료일

    해당일 이전에 결제완료된 주문 검색

    limit

    최대값: [50]

    조회결과 최대건수

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

    DEFAULT 20

    offset

    최대값: [10000]

    조회결과 시작위치

    조회결과 시작위치

    Count all appstore payments

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/appstore/payments/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/appstore/payments/count?start_date=2018-04-06&end_date=2018-07-05' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    기본스펙

    Property Description
    SCOPE 앱 읽기권한 (READ_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    order_id

    주문번호

    조회하고자하는 앱스토어 주문 번호

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

    start_date
    Required

    날짜
    timezone

    검색 시작일

    해당일 이후에 결제완료된 주문 검색

    end_date
    Required

    날짜
    timezone

    검색 종료일

    해당일 이전에 결제완료된 주문 검색

    Brands

    브랜드(Brands)는 상품의 "제작정보" 중 브랜드에 입력하는 정보를 의미합니다. 브랜드는 쇼핑몰의 상품을 구분하는 판매분류의 하나로 상품은 반드시 하나의 브랜드를 갖고 있습니다.(미지정시 "자체브랜드"를 사용함)
    브랜드(Brands)의 {#id}는 "brand_code"입니다.

    Brands properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    brand_code

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

    브랜드 코드

    brand_name

    최대글자수 : [50자]

    브랜드 명

    use_brand

    브랜드 사용여부

    T : 사용함
    F : 사용안함

    created_date

    생성일

    product_count

    상품수

    List all brands

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/brands'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/brands' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "brands": [
            {
                "shop_no": 1,
                "brand_code": "B0000000",
                "brand_name": "Default Brand",
                "use_brand": "T",
                "created_date": "2018-01-01",
                "product_count": 2
            },
            {
                "shop_no": 1,
                "brand_code": "B000000A",
                "brand_name": "Default Brand",
                "use_brand": "F",
                "created_date": "2018-01-02",
                "product_count": 3
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 읽기권한 (READ_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    brand_code

    브랜드 코드

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

    brand_name

    브랜드 명

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

    use_brand

    브랜드 사용여부

    T : 사용함
    F : 사용안함

    limit

    최대값: [100]

    조회결과 최대건수

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

    DEFAULT 10

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Count all brands

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/brands/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/brands/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 읽기권한 (READ_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    brand_code

    브랜드 코드

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

    brand_name

    브랜드 명

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

    use_brand

    브랜드 사용여부

    T : 사용함
    F : 사용안함

    Categories

    Categories Entity 관계도

    상품 분류(Categories)는 쇼핑몰 고객이 상품을 찾기 쉽도록 상품을 진열하거나 분류할 수 있는 카테고리입니다. 상품을 하나 이상의 상품 분류에 진열해야 판매 가능합니다. 하나의 상품은 여러 상품분류에 진열될 수 있습니다.
    상품 분류(Categories)의 {#id}는 "category_no"입니다.

    Categories properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    category_no

    분류 번호

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

    category_depth

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

    분류 Depth

    해당 상품분류가 하위 몇 차 상품분류에 있는 카테고리인지 표시함. 1~4차까지 상품분류가 존재한다.

    parent_category_no

    부모 분류 번호

    해당 상품분류가 2차(중분류), 3차(소분류), 4차(세분류)일 경우 상위에 있는 상품분류의 번호를 표시함.

    parent_category_no = 1일 경우 해당 분류는 대분류를 의미한다.

    category_name

    최대글자수 : [50자]

    분류명

    해당 상품분류의 이름을 나타낸다.

    display_type

    쇼핑몰 표시설정

    해당 상품분류가 PC 쇼핑몰이나 모바일 쇼핑몰, 둘 다에 노출되는지 표시.

    A : PC + 모바일
    P : PC
    M : 모바일
    F : 모두 사용안함

    full_category_name

    분류 전체 이름

    해당 상품분류가 속해있는 상위 상품분류의 이름을 모두 표시.

    full_category_no

    분류 전체 번호

    해당 상품분류가 속해있는 상위 상품분류의 번호를 모두 표시.

    root_category_no

    최상위 분류 번호

    해당 상품분류가 속해있는 최상위 상품분류의 분류 번호 표시.

    use_main

    메인분류 표시상태

    해당 상품분류가 쇼핑몰 메인에 표시되는지 여부. 메인분류에 표시하는 경우 중/소/상세 분류도 대분류처럼 최상위에 표시된다.

    T : 표시함
    F : 표시안함

    use_display

    표시상태

    해당 상품분류의 표시 여부. 표시안함 일 경우 해당 상품분류에 접근할 수 없다.

    해당 설정은 멀티쇼핑몰별로 설정할 수 없으며 모든 쇼핑몰에 적용된다.

    T : 표시함
    F : 표시안함

    display_order

    진열 순서

    상품분류를 쇼핑몰 운영자가 배치한 순서.

    soldout_product_display

    품절상품진열

    품절 상품을 상품 분류의 맨 앞 또는 맨 뒤에 진열할 것인지 여부
    상품의 품절 여부는 List all products를 통해 sold_out 파라메터로 알 수 있다.

    B : 품절상품 맨 뒤로
    F : 품절상품 맨 앞으로
    N : 품절상품 상관없음

    sub_category_product_display

    하위분류 상품진열

    현재 상품 분류 하위 분류에 진열된 상품들까지 포함하여 진열할 것인지 여부

    T : 진열함
    F : 진열안함

    hashtag_product_display

    쇼핑 큐레이션 해시태그 상품진열

    해시태그 상품 진열 기능을 사용할 것인지 여부

    ※ 해당 기능은 쇼핑 큐레이션 서비스를 사용하는 경우에만 사용 가능하다.

    T : 진열함
    F : 진열안함

    hash_tags

    쇼핑 큐레이션 해시태그

    해당 상품분류의 해시태그 목록

    ※ 해당 기능은 쇼핑 큐레이션 서비스를 사용하는 경우에만 사용 가능하다.

    product_display_scope

    상품분류 진열영역 구분

    상품 분류에 상품을 동일하게 정렬할 것인지, 영역별로 정렬할 것인지 설정

    "전체"로 설정된 경우 다음 항목을 통해 정렬 설정 가능하다.
    product_display_type
    product_display_key
    product_display_sort
    product_display_period

    "영역별"로 설정된 경우 다음 항목을 통해 영역별로 정렬 설정이 가능하다.
    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period

    A : 전체
    G : 영역별

    product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "전체"일 경우 해당 상품 분류의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "전체"이고, 상품분류 진열방법이 "자동정렬" 또는 "자동정렬 + 사용자지정"일 경우 해당 상품 분류를 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    product_display_sort

    상품분류 진열방법 순서

    상품분류 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    product_display_period

    진열순서에 대한 기간

    진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    normal_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 일반 상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    normal_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 일반 상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    normal_product_display_sort

    상품분류 진열방법 순서

    일반 상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    normal_product_display_period

    진열순서에 대한 기간

    일반 상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    recommend_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 추천 상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    recommend_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 추천 상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    recommend_product_display_sort

    상품분류 진열방법 순서

    추천 상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    recommend_product_display_period

    진열순서에 대한 기간

    추천 상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    new_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 신상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    new_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 신상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    new_product_display_sort

    상품분류 진열방법 순서

    신상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    new_product_display_period

    진열순서에 대한 기간

    신상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    List all categories

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/categories'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories' \
      -H 'Authorization: Bearer {access_token}' \
      -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",
                "display_type": "A",
                "full_category_name": {
                    "1": "(Main Category) Tops",
                    "2": "(Middle Category) Tees",
                    "3": "(Small Category) Long Sleeve",
                    "4": "(Detailed Category) Cropped"
                },
                "root_category_no": 27,
                "use_main": "F",
                "use_display": "T",
                "display_order": 0,
                "full_category_no": {
                    "1": "25",
                    "2": "28",
                    "3": "30",
                    "4": "40"
                },
                "soldout_product_display": "B",
                "sub_category_product_display": "T",
                "hashtag_product_display": "T",
                "hash_tags": [
                    "tag1",
                    "tag2"
                ],
                "product_display_scope": "A",
                "product_display_type": "U",
                "product_display_key": "A",
                "product_display_sort": "D",
                "product_display_period": "W",
                "normal_product_display_type": null,
                "normal_product_display_key": null,
                "normal_product_display_sort": null,
                "normal_product_display_period": null,
                "recommend_product_display_type": null,
                "recommend_product_display_key": null,
                "recommend_product_display_sort": null,
                "recommend_product_display_period": null,
                "new_product_display_type": null,
                "new_product_display_key": null,
                "new_product_display_sort": null,
                "new_product_display_period": null
            },
            {
                "shop_no": 1,
                "category_no": 28,
                "category_depth": 1,
                "parent_category_no": 1,
                "category_name": "(large scale classification) Accessories",
                "display_type": "A",
                "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
                },
                "use_main": "F",
                "use_display": "T",
                "display_order": 0,
                "soldout_product_display": "B",
                "sub_category_product_display": "T",
                "hashtag_product_display": "T",
                "hash_tags": [
                    "tag1",
                    "tag2"
                ],
                "product_display_scope": "A",
                "product_display_type": "U",
                "product_display_key": "A",
                "product_display_sort": "D",
                "product_display_period": "W",
                "normal_product_display_type": null,
                "normal_product_display_key": null,
                "normal_product_display_sort": null,
                "normal_product_display_period": null,
                "recommend_product_display_type": null,
                "recommend_product_display_key": null,
                "recommend_product_display_sort": null,
                "recommend_product_display_period": null,
                "new_product_display_type": null,
                "new_product_display_key": null,
                "new_product_display_sort": null,
                "new_product_display_period": null
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품분류 읽기권한 (READ_CATEGORY)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    category_depth

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

    분류 Depth

    조회하고자 하는 상품분류의 차수 검색

    category_no

    분류 번호

    조회하고자 하는 상품분류의 번호

    parent_category_no

    부모 분류 번호

    조회하고자 하는 상품분류의 부모 상품분류 번호 검색

    대분류만 검색하고자 할 경우 parent_category_no =1 로 검색한다.

    category_name

    분류명

    검색어를 분류명에 포함하고 있는 상품분류 검색(대소문자 구분 없음)

    limit

    최대값: [100]

    조회결과 최대건수

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

    DEFAULT 10

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Count all categories

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/categories/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    기본스펙

    Property Description
    SCOPE 상품분류 읽기권한 (READ_CATEGORY)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    category_depth

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

    분류 Depth

    조회하고자 하는 상품분류의 차수 검색

    category_no

    분류 번호

    조회하고자 하는 상품분류의 번호

    parent_category_no

    부모 분류 번호

    조회하고자 하는 상품분류의 부모 상품분류 번호 검색

    대분류만 검색하고자 할 경우 parent_category_no =1 로 검색한다.

    category_name

    분류명

    검색어를 분류명에 포함하고 있는 상품분류 검색(대소문자 구분 없음)

    Get a category

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/categories/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories/40' \
      -H 'Authorization: Bearer {access_token}' \
      -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",
            "display_type": "A",
            "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"
            },
            "use_main": "F",
            "use_display": "T",
            "display_order": 0,
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "T",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "A",
            "product_display_type": "U",
            "product_display_key": "A",
            "product_display_sort": "D",
            "product_display_period": "W",
            "normal_product_display_type": null,
            "normal_product_display_key": null,
            "normal_product_display_sort": null,
            "normal_product_display_period": null,
            "recommend_product_display_type": null,
            "recommend_product_display_key": null,
            "recommend_product_display_sort": null,
            "recommend_product_display_period": null,
            "new_product_display_type": null,
            "new_product_display_key": null,
            "new_product_display_sort": null,
            "new_product_display_period": null
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품분류 읽기권한 (READ_CATEGORY)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    category_no
    Required

    분류 번호

    조회하고자 하는 상품분류의 번호

    Create a category

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/categories'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "parent_category_no": 1,
            "category_name": "(large scale classification) Bottoms",
            "display_type": "A",
            "use_display": "T",
            "use_main": "T",
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "T",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "A",
            "product_display_type": "U",
            "product_display_key": "A",
            "product_display_sort": "D",
            "product_display_period": "W",
            "normal_product_display_type": null,
            "normal_product_display_key": null,
            "normal_product_display_sort": null,
            "normal_product_display_period": null,
            "recommend_product_display_type": null,
            "recommend_product_display_key": null,
            "recommend_product_display_sort": null,
            "recommend_product_display_period": null,
            "new_product_display_type": null,
            "new_product_display_key": null,
            "new_product_display_sort": null,
            "new_product_display_period": null
        }
    }'
    

    Response example:

    {
        "category": {
            "shop_no": 1,
            "category_no": 40,
            "category_depth": 1,
            "parent_category_no": 1,
            "category_name": "(large scale classification) Bottoms",
            "display_type": "A",
            "full_category_name": {
                "1": "(large scale classification) Bottoms",
                "2": null,
                "3": null,
                "4": null
            },
            "full_category_no": {
                "1": "40",
                "2": null,
                "3": null,
                "4": null
            },
            "root_category_no": 40,
            "use_main": "T",
            "use_display": "T",
            "display_order": 5,
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "T",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "A",
            "product_display_type": "U",
            "product_display_key": "A",
            "product_display_sort": "D",
            "product_display_period": "W",
            "normal_product_display_type": null,
            "normal_product_display_key": null,
            "normal_product_display_sort": null,
            "normal_product_display_period": null,
            "recommend_product_display_type": null,
            "recommend_product_display_key": null,
            "recommend_product_display_sort": null,
            "recommend_product_display_period": null,
            "new_product_display_type": null,
            "new_product_display_key": null,
            "new_product_display_sort": null,
            "new_product_display_period": null
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품분류 쓰기권한 (WRITE_CATEGORY)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    parent_category_no

    부모 분류 번호

    등록하고자 하는 상품분류의 부모 분류 번호

    상품분류를 특정 분류 하위에 등록하고자 할 경우 해당 분류 번호를 입력하여 등록 가능하다.

    category_name
    Required

    최대글자수 : [50자]

    분류명

    해당 상품분류의 이름

    display_type

    쇼핑몰 표시설정

    해당 상품분류가 PC 쇼핑몰이나 모바일 쇼핑몰, 둘 다에 노출되는지 설정

    A : PC + 모바일
    P : PC
    M : 모바일
    F : 모두 사용안함

    use_main

    메인분류 표시상태

    해당 상품분류가 쇼핑몰 메인에 표시되는지 여부. 메인분류에 표시하는 경우 중/소/상세 분류도 대분류처럼 최상위에 표시된다.

    T : 표시함
    F : 표시안함

    use_display

    표시상태

    해당 상품분류의 표시 여부. 표시안함 일 경우 해당 상품분류에 접근할 수 없다.

    해당 설정은 멀티쇼핑몰별로 설정할 수 없으며 모든 쇼핑몰에 적용된다.

    T : 표시함
    F : 표시안함

    soldout_product_display

    품절상품진열

    품절 상품을 상품 분류의 맨 앞 또는 맨 뒤에 진열할 것인지 여부

    B : 품절상품 맨 뒤로
    F : 품절상품 맨 앞으로
    N : 품절상품 상관없음

    sub_category_product_display

    하위분류 상품진열

    현재 상품 분류 하위 분류에 진열된 상품들까지 포함하여 진열할 것인지 여부

    T : 진열함
    F : 진열안함

    hashtag_product_display

    쇼핑 큐레이션 해시태그 상품진열

    해시태그 상품 진열 기능을 사용할 것인지 여부

    ※ 해당 기능은 쇼핑 큐레이션 서비스를 사용하는 경우에만 사용 가능하다.

    T : 진열함
    F : 진열안함

    hash_tags

    쇼핑 큐레이션 해시태그

    해당 상품분류의 해시태그 목록

    ※ 해당 기능은 쇼핑 큐레이션 서비스를 사용하는 경우에만 사용 가능하다.

    product_display_scope

    상품분류 진열영역 구분

    상품 분류에 상품을 동일하게 정렬할 것인지, 영역별로 정렬할 것인지 설정

    "전체"로 설정할 경우 다음 필드는 반드시 입력되어야 한다.
    product_display_type
    product_display_key
    product_display_sort
    product_display_period (key가 S, C일 때만 필수)

    "영역별"로 설정할 경우 다음 필드는 반드시 입력되어야 한다.
    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period (key가 S, C일 때만 필수)
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period (key가 S, C일 때만 필수)
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period (key가 S, C일 때만 필수)

    A : 전체
    G : 영역별

    product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "전체"일 경우 해당 상품 분류의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "전체"이고, 상품분류 진열방법이 "자동정렬" 또는 "자동정렬 + 사용자지정"일 경우 해당 상품 분류를 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    product_display_sort

    상품분류 진열방법 순서

    상품분류 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    product_display_period

    진열순서에 대한 기간

    진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    normal_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 일반 상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    normal_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 일반 상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    normal_product_display_sort

    상품분류 진열방법 순서

    일반 상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    normal_product_display_period

    진열순서에 대한 기간

    일반 상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    recommend_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 추천 상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    recommend_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 추천 상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    recommend_product_display_sort

    상품분류 진열방법 순서

    추천 상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    recommend_product_display_period

    진열순서에 대한 기간

    추천 상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    new_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 신상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    new_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 신상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    new_product_display_sort

    상품분류 진열방법 순서

    신상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    new_product_display_period

    진열순서에 대한 기간

    신상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    Update a category

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/categories/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories/40' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "category_name": "(large scale classification) Pants",
            "display_type": "A",
            "use_display": "T",
            "use_main": "T",
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "F",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "G",
            "normal_product_display_type": "A",
            "normal_product_display_key": "S",
            "normal_product_display_sort": "D",
            "normal_product_display_period": "1M",
            "recommend_product_display_type": "A",
            "recommend_product_display_key": "R",
            "recommend_product_display_sort": "D",
            "recommend_product_display_period": "W",
            "new_product_display_type": "A",
            "new_product_display_key": "C",
            "new_product_display_sort": "D",
            "new_product_display_period": "W"
        }
    }'
    

    Response example:

    {
        "category": {
            "shop_no": 1,
            "category_no": 40,
            "category_depth": 4,
            "parent_category_no": 37,
            "category_name": "(large scale classification) Pants",
            "display_type": "A",
            "full_category_name": {
                "1": "(Main Category) Tops",
                "2": "(Middle Category) Tees",
                "3": "(Small Category) Long Sleeve",
                "4": "(large scale classification) Pants"
            },
            "full_category_no": {
                "1": "25",
                "2": "30",
                "3": "37",
                "4": "40"
            },
            "root_category_no": 25,
            "use_main": "T",
            "use_display": "T",
            "display_order": 5,
            "soldout_product_display": "B",
            "sub_category_product_display": "T",
            "hashtag_product_display": "F",
            "hash_tags": [
                "tag1",
                "tag2"
            ],
            "product_display_scope": "G",
            "product_display_type": null,
            "product_display_key": null,
            "product_display_sort": null,
            "product_display_period": null,
            "normal_product_display_type": "A",
            "normal_product_display_key": "S",
            "normal_product_display_sort": "D",
            "normal_product_display_period": "1M",
            "recommend_product_display_type": "A",
            "recommend_product_display_key": "R",
            "recommend_product_display_sort": "D",
            "recommend_product_display_period": "W",
            "new_product_display_type": "A",
            "new_product_display_key": "C",
            "new_product_display_sort": "D",
            "new_product_display_period": "W"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품분류 쓰기권한 (WRITE_CATEGORY)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    category_no
    Required

    분류 번호

    category_name

    최대글자수 : [50자]

    분류명

    해당 상품분류의 이름

    display_type

    쇼핑몰 표시설정

    해당 상품분류가 PC 쇼핑몰이나 모바일 쇼핑몰, 둘 다에 노출되는지 설정

    A : PC + 모바일
    P : PC
    M : 모바일
    F : 모두 사용안함

    use_main

    메인분류 표시상태

    해당 상품분류가 쇼핑몰 메인에 표시되는지 여부. 메인분류에 표시하는 경우 중/소/상세 분류도 대분류처럼 최상위에 표시된다.

    T : 표시함
    F : 표시안함

    use_display

    표시상태

    해당 상품분류의 표시 여부. 표시안함 일 경우 해당 상품분류에 접근할 수 없다.

    해당 설정은 멀티쇼핑몰별로 설정할 수 없으며 모든 쇼핑몰에 적용된다.

    T : 표시함
    F : 표시안함

    soldout_product_display

    품절상품진열

    품절 상품을 상품 분류의 맨 앞 또는 맨 뒤에 진열할 것인지 여부

    B : 품절상품 맨 뒤로
    F : 품절상품 맨 앞으로
    N : 품절상품 상관없음

    sub_category_product_display

    하위분류 상품진열

    현재 상품 분류 하위 분류에 진열된 상품들까지 포함하여 진열할 것인지 여부

    T : 진열함
    F : 진열안함

    hashtag_product_display

    쇼핑 큐레이션 해시태그 상품진열

    해시태그 상품 진열 기능을 사용할 것인지 여부

    ※ 해당 기능은 쇼핑 큐레이션 서비스를 사용하는 경우에만 사용 가능하다.

    T : 진열함
    F : 진열안함

    hash_tags

    쇼핑 큐레이션 해시태그

    해당 상품분류의 해시태그 목록

    ※ 해당 기능은 쇼핑 큐레이션 서비스를 사용하는 경우에만 사용 가능하다.

    product_display_scope

    상품분류 진열영역 구분

    상품 분류에 상품을 동일하게 정렬할 것인지, 영역별로 정렬할 것인지 설정

    "전체"로 설정할 경우 다음 필드는 반드시 입력되어야 한다.
    product_display_type
    product_display_key
    product_display_sort
    product_display_period (key가 S, C일 때만 필수)

    "영역별"로 설정할 경우 다음 필드는 반드시 입력되어야 한다.
    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period (key가 S, C일 때만 필수)
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period (key가 S, C일 때만 필수)
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period (key가 S, C일 때만 필수)

    A : 전체
    G : 영역별

    product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "전체"일 경우 해당 상품 분류의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "전체"이고, 상품분류 진열방법이 "자동정렬" 또는 "자동정렬 + 사용자지정"일 경우 해당 상품 분류를 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    product_display_sort

    상품분류 진열방법 순서

    상품분류 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    product_display_period

    진열순서에 대한 기간

    진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    normal_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 일반 상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    normal_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 일반 상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    normal_product_display_sort

    상품분류 진열방법 순서

    일반 상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    normal_product_display_period

    진열순서에 대한 기간

    일반 상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    recommend_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 추천 상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    recommend_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 추천 상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    recommend_product_display_sort

    상품분류 진열방법 순서

    추천 상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    recommend_product_display_period

    진열순서에 대한 기간

    추천 상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    new_product_display_type

    상품분류 진열방법

    상품분류 정렬 영역 설정이 "영역별"일 경우 신상품 영역의 진열 방법

    A : 자동정렬
    U : 사용자 지정
    M : 자동정렬 + 사용자 지정

    new_product_display_key

    상품분류 진열방법 키

    상품분류 정렬 영역 설정이 "영역별"일 경우 신상품 영역을 어떤 기준으로 정렬할 것인지 설정

    A : 최근 추가된 상품
    R : 최근 등록상품
    U : 최근 수정상품
    N : 상품명 가나다순
    P : 판매가 높은 상품
    S : 판매량 높은 상품
    C : 조회수가 높은 상품
    L : 좋아요수가 높은 상품

    new_product_display_sort

    상품분류 진열방법 순서

    신상품 영역의 진열 방법을 내림차순으로 할지, 오름차순으로 할지 설정

    D: 내림차순
    A : 오름차순

    new_product_display_period

    진열순서에 대한 기간

    신상품 영역의 진열 방법이 판매량 높은 상품(S), 조회수가 높은 상품(C) 일 경우 기준이 되는 기간

    W : 전체기간
    1D : 1일
    3D : 3일
    7D : 7일
    15D : 15일
    1M : 1개월
    3M : 3개월
    6M : 6개월

    Delete a category

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/categories/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/categories/24' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "category": {
            "category_no": 24
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품분류 쓰기권한 (WRITE_CATEGORY)
    호출건수 제한 30

    요청사양

    Parameter Description
    category_no
    Required

    분류 번호

    Classifications

    자체분류(Classifications)는 상품의 "제작정보" 중 자체분류에 입력하는 정보를 의미합니다. 자체분류는 상품을 구분하는 판매분류의 하나이며, 상품은 반드시 하나의 자체분류를 갖고 있습니다.(미지정시 "기본 자체분류"를 사용함)

    Classifications properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    classification_code

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

    자체분류 코드

    classification_name

    최대글자수 : [200자]

    자체분류 명

    classification_description

    최대글자수 : [300자]

    자체분류 설명

    use_classification

    사용여부

    created_date

    timezone

    생성일

    product_count

    상품수

    List all classifications

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/classifications'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/classifications' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "classifications": [
            {
                "shop_no": 1,
                "classification_code": "C000000A",
                "classification_name": "Default Classification",
                "classification_description": "Default Classification description",
                "use_classification": "T",
                "created_date": "2018-01-16T12:00:41+09:00",
                "product_count": 2
            },
            {
                "shop_no": 1,
                "classification_code": "C000000B",
                "classification_name": "Classification 1",
                "classification_description": "Classification 1 description",
                "use_classification": "T",
                "created_date": "2018-01-16T12:00:41+09:00",
                "product_count": 3
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 읽기권한 (READ_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    classification_code

    자체분류 코드

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

    classification_name

    자체분류 명

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

    use_classification

    사용여부

    limit

    최대값: [100]

    조회결과 최대건수

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

    DEFAULT 10

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Count all classifications

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/classifications/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/classifications/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 읽기권한 (READ_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    classification_code

    자체분류 코드

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

    classification_name

    자체분류 명

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

    use_classification

    사용여부

    Coupons

    Coupons Entity 관계도
    쿠폰(Coupons)은 상품의 가격을 할인하거나 배송비를 할인받을 수 있도록 쇼핑몰 회원에게 발급할 수 있는 혜택입니다. 쿠폰은 쇼핑몰의 판매를 촉진(프로모션)하기 위해 사용할 수 있으며, 다양한 형태로 회원에게 발급할 수 있습니다.
    쿠폰(Coupons)의 {#id}는 "coupon_no"입니다.

    Coupons properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    coupon_no

    쿠폰번호

    쿠폰번호

    coupon_type

    쿠폰유형

    쿠폰유형. 온라인 쿠폰과 오프라인 시리얼 쿠폰 유형이 있음.

    O : 온라인 쿠폰
    S : 오프라인 시리얼 쿠폰

    coupon_name

    쿠폰명

    쿠폰의 이름

    coupon_description

    쿠폰설명

    쿠폰의 설명

    created_date

    timezone

    생성일

    쿠폰의 생성 일자

    deleted

    쿠폰삭제 여부

    쿠폰이 삭제되었는지 여부.

    T : 삭제
    F : 삭제되지 않음

    is_stopped_issued_coupon

    쿠폰 완전삭제 (발급된 쿠폰 사용정지) 여부

    쿠폰이 완전 삭제되었는지 여부. 쿠폰이 완전 삭제되면 기존에 발급된 쿠폰도 더 이상 사용이 불가함.

    T : 완전삭제
    F : 완전삭제 아님

    pause_begin_datetime

    timezone

    쿠폰 발급 일시정지 시작시간

    쿠폰 발급을 조건부 자동발급으로 설정한 경우, 조건에 해당해도 발급을 일시정지하는 기간의 시작 시간

    pause_end_datetime

    timezone

    쿠폰 발급 일시정지 종료시간

    쿠폰 발급을 조건부 자동발급으로 설정한 경우, 조건에 해당해도 발급을 일시정지하는 기간의 종료 시간

    benefit_text

    쿠폰혜택 상세내역 출력

    쿠폰혜택의 상세 내역이 출력됨.

    benefit_type

    혜택 구분

    혜택의 유형. 각각의 유형별로 부여하는 혜택이 다름.

    A : 할인금액
    B : 할인율
    C : 적립금액
    D : 적립율
    E : 기본배송비 할인(전액할인)
    I : 기본배송비 할인(할인율)
    H : 기본배송비 할인(할인금액)
    F : 즉시적립

    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

    발급 구분

    쿠폰의 발급형태 유형

    M : 대상자 지정 발급
    A : 조건부 자동 발급
    D : 고객 다운로드 발급

    issue_sub_type

    발급 하위 유형

    쿠폰 발급의 세부 하위 유형

    M : 회원 대상
    C : 실시간 접속자 대상
    J : 회원 가입
    D : 배송 완료 시
    A : 기념일(생일)
    I : 모듈(프로그램) 설치
    P : 상품 후기 작성
    O : 주문 완료 시
    Q : 구매 수량 충족 시
    F : 첫 구매 고객
    N : 일정기간 미구매 회원 대상

    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

    timezone

    쿠폰발급 가능한 주문시작일시

    쿠폰발급 가능한 주문시작일시

    issue_order_end_date

    timezone

    쿠폰발급 가능한 주문종료일시

    쿠폰발급 가능한 주문종료일시

    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

    timezone

    자동 발행 예약 발급 일시

    설정된 쿠폰 자동 발행 예약 일시

    available_date

    쿠폰 사용기간

    쿠폰의 사용 가능한 기간

    available_period_type

    사용기간 유형

    쿠폰의 사용 가능한 기간의 유형

    F : 일반 기간
    R : 쿠폰 발급일 기준
    M : 당월 말까지 사용

    available_begin_datetime

    timezone

    사용 기간 시작 일시

    쿠폰 사용 가능 기간 시작일시

    available_end_datetime

    timezone

    사용 기간 종료 일시

    쿠폰 사용 가능 기간 종료일시

    available_site

    사용 범위 유형

    쿠폰 사용 가능한 접속경로의 유형

    W : 웹 쇼핑몰 전용
    M : 모바일 쇼핑몰 전용
    P : 플러스앱 전용

    available_scope

    적용 범위

    쿠폰 적용 가능한 범위. 상품 쿠폰으로 적용시 상품 하나에 대하여 쿠폰이 적용되며, 주문서 쿠폰으로 적용시 주문서 전체에 적용됨.

    P : 상품 쿠폰
    O : 주문서 쿠폰

    available_day_from_issued

    사용 가능 일수

    쿠폰의 사용 가능 일수

    available_price_type

    사용가능 구매 금액 유형

    쿠폰의 사용가능 금액에 대한 기준. 상품 금액 기준일 경우 상품 가격에 수량을 곱한 금액을 기준으로 하며, 주문 금액 기준일 경우 해당 금액에 기타 할인, 배송비가 적용된 금액을 기준으로 계산한다.

    U : 제한 없음
    O : 주문 금액 기준
    P : 상품 금액 기준

    available_min_price

    사용가능 구매 금액 유형

    쿠폰을 사용가능한 구매 금액

    available_amount_type

    적용 계산 기준

    쿠폰을 적용할 기준이 되는 결제 금액. 쿠폰할인을 각종 할인(회원등급할인, 상품할인 등)전 주문금액에 적용할지, 각종 할인 후 금액에 적용할지 여부.

    E : 할인(쿠폰 제외) 적용 전 결제 금액
    I : 할인(쿠폰 제외) 적용 후 결제 금액

    available_payment_method

    사용가능 결제수단

    쿠폰 사용이 가능한 결제수단

    R : 무통장입금
    E : 가상계좌
    C : 카드결제
    A : 실시간계좌이체
    H : 휴대폰결제
    M : 적립금결제
    K : 케이페이
    P : 페이나우
    N : 페이코
    O : 카카오페이

    available_product

    쿠폰적용 상품 선택

    쿠폰의 적용가능 상품 선택. 특정 상품을 제외하거나, 적용하거나 혹은 모든 상품에 대해서 쿠폰적용 여부를 선택할 수 있음.

    U : 제한 없음
    I : 선택 상품 적용
    E : 선택 상품 제외

    available_category

    쿠폰적용 분류 선택

    쿠폰의 적용가능 분류 선택. 특정 분류를 제외하거나, 적용하거나 혹은 모든 분류에 대해서 쿠폰적용 여부를 선택할 수 있음.

    U : 제한 없음
    I : 선택 카테고리 적용
    E : 선택 카테고리 제외

    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

    List all coupons

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/coupons'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/coupons' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "coupons": [
            {
                "shop_no": 1,
                "coupon_no": "9000000000000000033",
                "coupon_type": "O",
                "coupon_name": "Special Discount Coupon",
                "coupon_description": null,
                "created_date": "2017-12-19T14:39:22+09:00",
                "deleted": "F",
                "is_stopped_issued_coupon": "F",
                "pause_begin_datetime": null,
                "pause_end_datetime": null,
                "benefit_text": "20.0% Discount. No cuts. Maximum discount 50",
                "benefit_type": "B",
                "benefit_price": null,
                "benefit_percentage": "20.0",
                "benefit_percentage_round_unit": "0.1",
                "benefit_percentage_max_price": "50.00",
                "include_regional_shipping_rate": null,
                "include_foreign_delivery": null,
                "coupon_direct_url": "\/exec\/front\/newcoupon\/IssueDownload?coupon_no=",
                "issue_type": "M",
                "issue_sub_type": "M",
                "issue_member_join": null,
                "issue_member_join_recommend": null,
                "issue_member_join_type": null,
                "issue_order_amount_type": null,
                "issue_order_start_date": null,
                "issue_order_end_date": null,
                "issue_order_amount_limit": null,
                "issue_order_amount_min": null,
                "issue_order_amount_max": null,
                "issue_order_path": null,
                "issue_order_type": "O",
                "issue_order_available_product": "U",
                "issue_order_available_category": "U",
                "issue_anniversary_type": null,
                "issue_anniversary_pre_issue_day": null,
                "issue_module_type": null,
                "issue_review_count": null,
                "issue_review_has_image": null,
                "issue_quantity_min": null,
                "issue_quntity_type": null,
                "issue_max_count": null,
                "issue_max_count_by_user": null,
                "issue_count_per_once": null,
                "issued_count": "0",
                "issue_member_group_no": null,
                "issue_member_group_name": null,
                "issue_no_purchase_period": null,
                "issue_reserved": "F",
                "issue_reserved_date": null,
                "available_date": "2017-12-19 00:00 ~ 2017-12-22 23:00",
                "available_period_type": "F",
                "available_begin_datetime": "2017-12-19T00:00:00+09:00",
                "available_end_datetime": "2017-12-22T23:00:00+09:00",
                "available_site": "W,M",
                "available_scope": "O",
                "available_day_from_issued": null,
                "available_price_type": "U",
                "available_min_price": null,
                "available_amount_type": "E",
                "available_payment_method": "R,E,C,A,H,M,K,P,N,O",
                "available_product": "U",
                "available_category": "U",
                "available_coupon_count_by_order": 1,
                "serial_generate_method": null,
                "coupon_image_type": "B",
                "coupon_image_path": null,
                "show_product_detail": null,
                "use_notification_when_login": "F",
                "send_sms_for_issue": "F",
                "send_email_for_issue": null
            },
            {
                "shop_no": 1,
                "coupon_no": "9000000000000000032",
                "coupon_type": "O",
                "coupon_name": "Christmas Week Coupon",
                "coupon_description": null,
                "created_date": "2017-12-18T11:56:41+09:00",
                "deleted": "F",
                "is_stopped_issued_coupon": "F",
                "pause_begin_datetime": null,
                "pause_end_datetime": null,
                "benefit_text": "discount for 10",
                "benefit_type": "A",
                "benefit_price": "10.00",
                "benefit_percentage": null,
                "benefit_percentage_round_unit": null,
                "benefit_percentage_max_price": null,
                "include_regional_shipping_rate": null,
                "include_foreign_delivery": null,
                "coupon_direct_url": "\/exec\/front\/newcoupon\/IssueDownload?coupon_no=",
                "issue_type": "M",
                "issue_sub_type": "M",
                "issue_member_join": null,
                "issue_member_join_recommend": null,
                "issue_member_join_type": null,
                "issue_order_amount_type": null,
                "issue_order_start_date": null,
                "issue_order_end_date": null,
                "issue_order_amount_limit": null,
                "issue_order_amount_min": null,
                "issue_order_amount_max": null,
                "issue_order_path": null,
                "issue_order_type": "O",
                "issue_order_available_product": "U",
                "issue_order_available_category": "U",
                "issue_anniversary_type": null,
                "issue_anniversary_pre_issue_day": null,
                "issue_module_type": null,
                "issue_review_count": null,
                "issue_review_has_image": null,
                "issue_quantity_min": null,
                "issue_quntity_type": null,
                "issue_max_count": null,
                "issue_max_count_by_user": null,
                "issue_count_per_once": null,
                "issued_count": "0",
                "issue_member_group_no": null,
                "issue_member_group_name": null,
                "issue_no_purchase_period": null,
                "issue_reserved": "F",
                "issue_reserved_date": null,
                "available_date": "2017-12-18 00:00 ~ 2017-12-21 23:00",
                "available_period_type": "F",
                "available_begin_datetime": "2017-12-18T00:00:00+09:00",
                "available_end_datetime": "2017-12-21T23:00:00+09:00",
                "available_site": "W,M",
                "available_scope": "O",
                "available_day_from_issued": null,
                "available_price_type": "U",
                "available_min_price": null,
                "available_amount_type": "E",
                "available_payment_method": "R,E,C,A,H,M,K,P,N,O",
                "available_product": "U",
                "available_category": "U",
                "available_coupon_count_by_order": 1,
                "serial_generate_method": null,
                "coupon_image_type": "B",
                "coupon_image_path": null,
                "show_product_detail": null,
                "use_notification_when_login": "F",
                "send_sms_for_issue": "F",
                "send_email_for_issue": null
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 프로모션 읽기권한 (READ_PROMOTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    coupon_no

    쿠폰번호

    쿠폰번호

    coupon_type

    쿠폰유형

    쿠폰유형

    O : 온라인 쿠폰
    S : 오프라인 시리얼 쿠폰

    coupon_name

    쿠폰명

    쿠폰명

    benefit_type

    혜택 구분

    쿠폰으로 받는 혜택의 종류 구분

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

    A : 할인금액
    B : 할인율
    C : 적립금액
    D : 적립율
    E : 기본배송비 할인(전액할인)
    I : 기본배송비 할인(할인율)
    H : 기본배송비 할인(할인금액)
    F : 즉시적립

    issue_type

    발급 구분

    쿠폰의 발급형태 유형

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

    M : 대상자 지정 발급
    A : 조건부 자동 발급
    D : 고객 다운로드 발급

    issue_sub_type

    발급 하위 유형

    쿠폰 발급의 세부 하위 유형

    M : 회원 대상
    C : 실시간 접속자 대상
    J : 회원 가입
    D : 배송 완료 시
    A : 기념일(생일)
    I : 모듈(프로그램) 설치
    P : 상품 후기 작성
    O : 주문 완료 시
    Q : 구매 수량 충족 시
    F : 첫 구매 고객
    N : 일정기간 미구매 회원 대상

    issued_flag

    발급된 쿠폰 여부

    쿠폰이 기존에 발급된 이력이 있는지 여부

    T : 발급이력이 있는 쿠폰
    F : 발급이력이 없는 쿠폰

    created_start_date

    날짜
    timezone

    검색 시작일

    쿠폰 생성일 기준 검색의 검색 시작일
    검색 종료일과 같이 사용해야함.

    created_end_date

    날짜
    timezone

    검색 종료일

    쿠폰 생성일 기준 검색의 검색 종료일
    검색 시작일과 같이 사용해야함.

    deleted

    쿠폰삭제 여부

    쿠폰이 삭제되었는지 여부.

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

    T : 삭제된 쿠폰
    F : 삭제되지 않은 쿠폰

    DEFAULT F

    pause_begin_date

    날짜
    timezone

    쿠폰 발급 일시정지 시작시간

    쿠폰 일시정지일 기준 검색의 검색 시작일

    pause_end_date

    날짜
    timezone

    쿠폰 발급 일시정지 종료시간

    쿠폰 일시정지일 기준 검색의 검색 종료일

    issue_order_path

    주문경로

    발급한 쿠폰의 사용 가능한 주문 경로

    W : PC
    M : 모바일
    P : 플러스앱

    issue_order_type

    발급단위

    쿠폰의 발급 단위가 상품인지 주문서단위 쿠폰인지 여부

    P : 상품 쿠폰
    O : 주문서 쿠폰

    issue_reserved

    자동 발행 예약 사용 여부

    쿠폰의 자동발행예약 사용여부

    T : 사용
    F : 사용하지 않음

    available_period_type

    사용기간 유형

    쿠폰 사용기간의 유형

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

    F : 일반 기간
    R : 쿠폰 발급일 기준
    M : 당월 말까지 사용

    available_datetime

    날짜
    timezone

    해당 날짜에 발급 가능한 쿠폰 검색

    해당하는 날짜에 발급 가능한 쿠폰 검색

    available_period_type이 F일 때만 유효

    available_site

    사용 범위 유형

    발급한 쿠폰의 사용 가능한 주문 경로

    W : 웹 쇼핑몰 전용
    M : 모바일 쇼핑몰 전용
    P : 플러스앱 전용

    available_scope

    적용 범위

    쿠폰의 적용 가능한 범위가 상품인지 주문서단위 쿠폰인지 여부

    P : 상품 쿠폰
    O : 주문서 쿠폰

    available_price_type

    사용가능 구매 금액 유형

    쿠폰이 사용 가능한 금액 기준이 주문 금액 기준인지 상품 금액 기준인지 제한이 없는지 여부

    U : 제한 없음
    O : 주문 금액 기준
    P : 상품 금액 기준

    limit

    최대값: [500]

    조회결과 최대건수

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

    DEFAULT 100

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Count all coupons

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/coupons/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/coupons/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 24
    }
    

    기본스펙

    Property Description
    SCOPE 프로모션 읽기권한 (READ_PROMOTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    coupon_no

    쿠폰번호

    쿠폰번호

    coupon_type

    쿠폰유형

    조회할 쿠폰의 유형

    O : 온라인 쿠폰
    S : 오프라인 시리얼 쿠폰

    coupon_name

    쿠폰명

    쿠폰명

    benefit_type

    혜택 구분

    쿠폰으로 받는 혜택의 종류 구분

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

    A : 할인금액
    B : 할인율
    C : 적립금액
    D : 적립율
    E : 기본배송비 할인(전액할인)
    I : 기본배송비 할인(할인율)
    H : 기본배송비 할인(할인금액)
    F : 즉시적립

    issue_type

    발급 구분

    쿠폰의 발급형태 유형

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

    M : 대상자 지정 발급
    A : 조건부 자동 발급
    D : 고객 다운로드 발급

    issue_sub_type

    발급 하위 유형

    쿠폰 발급의 세부 하위 유형

    M : 회원 대상
    C : 실시간 접속자 대상
    J : 회원 가입
    D : 배송 완료 시
    A : 기념일(생일)
    I : 모듈(프로그램) 설치
    P : 상품 후기 작성
    O : 주문 완료 시
    Q : 구매 수량 충족 시
    F : 첫 구매 고객
    N : 일정기간 미구매 회원 대상

    issued_flag

    발급된 쿠폰 여부

    쿠폰이 기존에 발급된 이력이 있는지 여부

    T : 발급이력이 있는 쿠폰
    F : 발급이력이 없는 쿠폰

    created_start_date

    날짜
    timezone

    검색 시작일

    쿠폰 생성일 기준 검색의 검색 시작일
    검색 종료일과 같이 사용해야함.

    created_end_date

    날짜
    timezone

    검색 종료일

    쿠폰 생성일 기준 검색의 검색 종료일
    검색 시작일과 같이 사용해야함.

    deleted

    쿠폰삭제 여부

    쿠폰이 삭제되었는지 여부.

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

    T : 삭제된 쿠폰
    F : 삭제되지 않은 쿠폰

    DEFAULT F

    pause_begin_date

    날짜
    timezone

    쿠폰 발급 일시정지 시작시간

    쿠폰 발급이 일시정지 되기 시작한 시간.

    pause_end_date

    날짜
    timezone

    쿠폰 발급 일시정지 종료시간

    쿠폰 발급의 일시정지가 종료된 시간.

    issue_order_path

    주문경로

    발급한 쿠폰의 사용 가능한 주문 경로

    W : PC
    M : 모바일
    P : 플러스앱

    issue_order_type

    발급단위

    발급단위

    P : 상품 쿠폰
    O : 주문서 쿠폰

    issue_reserved

    자동 발행 예약 사용 여부

    자동발행예약 사용여부

    T : 사용
    F : 사용하지 않음

    available_period_type

    사용기간 유형

    쿠폰 사용기간의 유형

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

    F : 일반 기간
    R : 쿠폰 발급일 기준
    M : 당월 말까지 사용

    available_datetime

    날짜
    timezone

    해당 날짜에 발급 가능한 쿠폰 검색

    해당하는 날짜에 발급 가능한 쿠폰 검색

    available_period_type이 F일 때만 유효

    available_site

    사용 범위 유형

    발급한 쿠폰의 사용 가능한 주문 경로

    W : 웹 쇼핑몰 전용
    M : 모바일 쇼핑몰 전용
    P : 플러스앱 전용

    available_scope

    적용 범위

    쿠폰의 적용 가능한 범위가 상품인지 주문서단위 쿠폰인지 여부

    P : 상품 쿠폰
    O : 주문서 쿠폰

    available_price_type

    사용가능 구매 금액 유형

    쿠폰이 사용 가능한 금액 기준이 주문 금액 기준인지 상품 금액 기준인지 제한이 없는지 여부

    U : 제한 없음
    O : 주문 금액 기준
    P : 상품 금액 기준

    Coupons issue

    쿠폰의 발급내역(Issue)은 쿠폰을 회원에게 발급한 발급 목록입니다. 쿠폰 발급 내역에 회원 정보와 쿠폰 번호를 등록하면 회원에게 쿠폰을 발급할 수 있습니다.

    Coupons issue properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    count

    카운트

    쿠폰번호별 발급 성공회원 수

    Create a coupons issue

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/coupons/{#id}/issue'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/coupons/9000000000000000031/issue' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "issued_member_scope": "M",
            "member_id": "testmember",
            "allow_duplication": "T",
            "single_issue_per_once": "F",
            "issue_count_per_once": 3
        }
    }'
    

    Response example:

    {
        "issue": {
            "shop_no": 1,
            "count": {
                "9000000000000000031": 1
            }
        }
    }
    

    기본스펙

    Property Description
    SCOPE 프로모션 쓰기권한 (WRITE_PROMOTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    coupon_no
    Required

    쿠폰번호

    쿠폰번호

    issued_member_scope
    Required

    회원/조건 선택

    쿠폰 발급 대상 회원의 범위를 특정하여 쿠폰을 발급할 수 있음.
    특정회원그룹(G)을 입력할 경우 group_no를 필수로 입력해야한다.
    특정회원(M)을 입력할 경우 member_id를 필수로 입력해야한다.

    A : 전체 회원
    G : 특정 회원 그룹
    M : 특정 회원

    group_no

    회원등급번호

    회원그룹번호

    member_id

    회원아이디

    회원아이디

    send_sms_for_issue
    Required

    쿠폰발급 SMS 발송 여부

    쿠폰 발급정보를 SMS로 발송할지 여부

    T : 발송함
    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

    발급자 ID

    Currency

    Currency properties

    Attribute Description
    exchange_rate

    결제 화폐 환율 정보

    standard_currency_code

    기준 화폐 코드

    해당 쇼핑몰의 기본쇼핑몰에서 사용하는 화폐 코드. 기준 화폐란 일반적으로 쇼핑몰 운영자가 속한 국가에서 통용되는 화폐를 의미한다.

    standard_currency_symbol

    기준 화폐 심볼

    해당 쇼핑몰의 기본쇼핑몰에서 사용하는 화폐의 화폐 기호. 기준 화폐란 일반적으로 쇼핑몰 운영자가 속한 국가에서 통용되는 화폐를 의미한다.

    shop_currency_code

    결제 화폐 코드

    shop_currency_symbol

    결제 화폐 심볼

    Get currency setting

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/currency'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/currency' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "currency": {
            "exchange_rate": 1004,
            "standard_currency_code": "KRW",
            "standard_currency_symbol": "₩",
            "shop_currency_code": "USD",
            "shop_currency_symbol": "$"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (READ_STORE)
    호출건수 제한 30

    Customergroup

    Customer Group Entity 관계도

    회원등급(CustomerGroups)은 회원을 관리하기 위해 회원을 그룹으로 분류한 개념입니다. 회원은 반드시 하나의 회원등급에 속하게 되며, 따로 등급을 지정하지 않았을 경우 "일반회원"으로 분류됩니다. 회원등급에 따라 혜택을 제공하거나 특정 회원 등급에만 메시지를 전송하도록 할 수 있습니다.

    회원등급(CustomerGroups)의 {#id}는 "group_no"입니다.

    Customergroup properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    group_no

    회원등급번호

    시스템이 회원등급에 부여한 번호.

    group_name

    회원등급명

    회원등급을 만들 당시 지정한 회원등급의 이름.

    group_description

    회원 등급설명

    회원등급을 만들 당시 입력한 회원등급의 설명.

    benefits_paymethod

    혜택 결제조건

    혜택을 받기 위한 결제조건. 모든결제, 현금, 또는 현금을 제외한 모든결제 3가지 경우에 대하여 혜택 결제조건 설정이 가능함.

    A : 모든 결제
    B : 현금 결제(무통장)
    C : 현금 결제 외 모든 결제

    buy_benefits

    구매시 할인/적립 혜택

    구매 시 적용되는 할인이나 적립 혜택

    F : 혜택없음
    D : 구매금액 할인
    M : 적립금 지급
    P : 할인/적립 동시 적용

    ship_benefits

    배송비 혜택

    배송비 혜택. 무료배송 또는 유료배송으로 구분함.

    T : 배송비무료설정
    F : 배송비무료설정안함

    product_availability

    상품별 할인 중복설정

    상품별 할인혜택을 설정함. 상품별 가격할인만 적용하거나 회원등급별 가격할인만 적용하거나 둘 다 중복하여 할인하도록 적용할 수 있음.

    P : 상품별 가격할인만 적용
    M : 회원등급별 가격할인만 적용
    A : 둘다적용

    discount_information

    구매금액 할인설정

    구매금액에 따른 할인 설정. 최소결제금액에 따라서 할인금액을 설정할 수 있음.

    mileage_information

    적립금 지급설정

    적립금 지금에 대한 설정. 최소결제금액에 따라서 적립금 지급액을 설정할 수 있음.

    mobile_discount_information

    모바일 추가 할인설정

    모바일 구매금액에 따른 추가 할인 설정. 최소결제금액에 따라서 할인금액을 설정할 수 있음.

    mobile_mileage_information

    모바일 추가 적립금설정

    모바일 구매금액에 따른 추가 적립금 설정. 최소결제금액에 따라서 적립금 지급액을 설정할 수 있음.

    List all customergroup

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customergroup'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customergroup' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customergroup": [
            {
                "shop_no": "1",
                "group_no": "1",
                "group_name": "Standard Membership",
                "group_description": "Group information",
                "benefits_paymethod": "A",
                "buy_benefits": "D",
                "ship_benefits": "F",
                "product_availability": "A",
                "discount_information": {
                    "amount_product": "100000.00",
                    "amount_discount": "100.00",
                    "discount_unit": "P",
                    "truncation_unit": "10",
                    "max_discount": "10.00"
                },
                "mileage_information": {
                    "amount_product": "100000.00",
                    "amount_discount": "20.00",
                    "discount_unit": "P",
                    "truncation_unit": "100",
                    "max_discount": "100.00"
                },
                "mobile_discount_information": {
                    "amount_product": "100000.00",
                    "amount_discount": "20.00",
                    "discount_unit": "P",
                    "truncation_unit": "100",
                    "max_discount": "100.00"
                },
                "mobile_mileage_information": {
                    "amount_product": "100000.00",
                    "amount_discount": "20.00",
                    "discount_unit": "P",
                    "truncation_unit": "100",
                    "max_discount": "100.00"
                }
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 회원 읽기권한 (READ_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    group_no

    회원등급번호

    시스템이 회원등급에 부여한 번호.

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

    group_name

    최대글자수 : [20자]

    회원등급명

    회원등급을 만들 당시 지정한 회원등급의 이름.

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

    Count all customergroup

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customergroup/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customergroup/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 1
    }
    

    기본스펙

    Property Description
    SCOPE 회원 읽기권한 (READ_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    group_no

    회원등급번호

    시스템이 회원등급에 부여한 번호.

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

    group_name

    최대글자수 : [20자]

    회원등급명

    회원등급을 만들 당시 지정한 회원등급의 이름.

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

    Get a customergroup

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customergroup/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customergroup/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customergroup": {
            "shop_no": "1",
            "group_no": "1",
            "group_name": "Standard Membership",
            "group_description": "Group information",
            "benefits_paymethod": "A",
            "buy_benefits": "D",
            "ship_benefits": "F",
            "product_availability": "A",
            "discount_information": {
                "amount_product": "100000.00",
                "amount_discount": "100.00",
                "discount_unit": "P",
                "truncation_unit": "10",
                "max_discount": "10.00"
            },
            "mileage_information": {
                "amount_product": "100000.00",
                "amount_discount": "20.00",
                "discount_unit": "P",
                "truncation_unit": "100",
                "max_discount": "100.00"
            },
            "mobile_discount_information": {
                "amount_product": "100000.00",
                "amount_discount": "20.00",
                "discount_unit": "P",
                "truncation_unit": "100",
                "max_discount": "100.00"
            },
            "mobile_mileage_information": {
                "amount_product": "100000.00",
                "amount_discount": "20.00",
                "discount_unit": "P",
                "truncation_unit": "100",
                "max_discount": "100.00"
            }
        }
    }
    

    기본스펙

    Property Description
    SCOPE 회원 읽기권한 (READ_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    group_no
    Required

    회원등급번호

    시스템이 회원등급에 부여한 번호.

    Customers

    Customers Entity 구조

    회원(Customers)은 쇼핑몰의 상품을 구매하는 고객들 중 쇼핑몰의 쿠폰, 적립금, 할인 등의 혜택을 받기 위해 가입한 고객들입니다. 회원 관리를 위해 쇼핑몰 운영자는 회원을 특정 회원 등급으로 분류하거나 특별회원으로 지정할 수 있습니다.

    Customers properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    member_id

    최대글자수 : [20자]

    회원아이디

    회원 아이디

    name

    이름

    해당 회원의 이름

    available_mileage

    가용 적립금

    해당 회원의 사용 가능한 적립금

    group_no

    회원등급번호

    해당 회원의 회원등급의 번호

    member_authentication

    회원인증여부

    회원 인증여부. 인증에 따라 회원은 4종류로 구분된다. 인증회원을 특별관리회원으로 설정할 경우 해당 회원은 가장 마지막에 설정한 특별관리회원으로 표시된다.

    T : 인증
    F : 미인증
    B : 특별관리회원
    J : 14세미만회원

    use_blacklist

    불량회원설정

    불량회원 여부. 불량회원일 경우 불량회원 타입에 따라 상품구매 차단, 로그인 차단, 로그인과 상품구매 모두를 차단할 수 있음.

    T : 설정함
    F : 설정안함

    blacklist_type

    불량회원 차단설정

    해당 회원의 불량회원 타입. 불량회원 타입에 따라 상품구매 차단, 로그인 차단, 로그인과 상품구매 모두를 차단할 수 있음.

    P : 상품구매차단
    L : 로그인차단
    A : 로그인&상품구매 차단

    Search customers

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers?cellphone=010-1000-0000' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customers": [
            {
                "shop_no": 1,
                "member_id": "sampleid",
                "name": "Jo****",
                "available_mileage": "00.00",
                "group_no": 1,
                "member_authentication": "T",
                "use_blacklist": "F",
                "blacklist_type": ""
            },
            {
                "shop_no": 1,
                "member_id": "sampleid01",
                "name": "Ja****",
                "available_mileage": "00.00",
                "group_no": 1,
                "member_authentication": "T",
                "use_blacklist": "F",
                "blacklist_type": ""
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 회원 읽기권한 (READ_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    cellphone
    Required

    휴대전화

    쇼핑몰 회원을 검색할 휴대전화번호. 개인정보 보호를 위해 전체 휴대전화번호를 다 입력해야만 검색이 가능하다.

    Customers memos

    Customers memos properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    memo_no

    메모 번호

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

    author_id

    작성자 아이디

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

    memo

    메모 내용

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

    important_flag

    중요 메모 여부

    중요 메모의 구분여부.

    T : 중요 메모
    F : 일반 메모

    created_date

    timezone

    생성일

    메모를 작성한 시간.

    Count all customers memos

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    기본스펙

    Property Description
    SCOPE 회원 읽기권한 (READ_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    member_id
    Required

    회원아이디

    회원아이디

    List all customers memos

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memos": [
            {
                "shop_no": 1,
                "memo_no": 1,
                "author_id": "subadmin1",
                "memo": "This is a sample memo.",
                "important_flag": "T",
                "created_date": "2018-01-18T11:19:27+09:00"
            },
            {
                "shop_no": 1,
                "memo_no": 2,
                "author_id": "subadmin2",
                "memo": "This is a sample memo.",
                "important_flag": "F",
                "created_date": "2018-01-18T11:19:27+09:00"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 회원 읽기권한 (READ_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    member_id
    Required

    회원아이디

    회원아이디

    limit

    최대값: [100]

    조회결과 최대건수

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

    DEFAULT 10

    offset

    최대값: [10000]

    조회결과 시작위치

    조회결과 시작위치

    Get a customers memo

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memo": {
            "shop_no": 1,
            "memo_no": 1,
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T",
            "created_date": "2018-01-18T11:19:27+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 회원 읽기권한 (READ_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    memo_no
    Required

    메모 번호

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

    member_id
    Required

    회원아이디

    회원아이디

    Create a customers memo

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T"
        }
    }'
    

    Response example:

    {
        "memo": {
            "shop_no": 1,
            "memo_no": 1,
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T",
            "created_date": "2018-01-18T11:19:27+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 회원 쓰기권한 (WRITE_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    member_id
    Required

    회원아이디

    회원아이디

    author_id
    Required

    최대글자수 : [20자]

    작성자 아이디

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

    memo
    Required

    메모

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

    important_flag

    중요 메모 여부

    중요 메모의 구분여부.

    T : 중요 메모
    F : 일반 메모

    DEFAULT F

    Update a customers memo

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos/3' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T"
        }
    }'
    

    Response example:

    {
        "memo": {
            "shop_no": 1,
            "memo_no": 1,
            "author_id": "subadmin1",
            "memo": "This is a sample memo.",
            "important_flag": "T",
            "created_date": "2018-01-18T11:19:27+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 회원 쓰기권한 (WRITE_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    memo_no
    Required

    메모 번호

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

    member_id
    Required

    회원아이디

    회원아이디

    author_id
    Required

    최대글자수 : [20자]

    작성자 아이디

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

    memo

    메모

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

    important_flag

    중요 메모 여부

    중요 메모의 구분여부.

    T : 중요 메모
    F : 일반 메모

    Delete a customers memo

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/memos/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/testmember/memos/3' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memo": {
            "shop_no": 1,
            "memo_no": 3
        }
    }
    

    기본스펙

    Property Description
    SCOPE 회원 쓰기권한 (WRITE_CUSTOMER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    memo_no
    Required

    메모 번호

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

    member_id
    Required

    회원아이디

    회원아이디

    Customers reviews

    고객 리뷰(Customer Reviews)는 쇼핑몰 고객별로 작성한 리뷰 목록을 확인할 수 있는 관계형 Entity입니다.

    Customers reviews properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

    상품 번호

    review_no

    리뷰 번호

    order_id

    주문번호

    주문 번호

    nickname

    작성자 별명

    title

    리뷰 제목

    content

    리뷰 내용

    content_text_length

    리뷰글 텍스트 길이

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    writer

    작성자명

    writing_id

    작성자 회원 아이디

    created_date

    날짜
    timezone

    작성일자

    comment_count

    댓글 갯수

    like_count

    최소값: [0]

    좋아요 횟수

    share_count

    최소값: [0]

    SNS 공유 횟수

    hit_count

    최소값: [0]

    조회수

    additional_information

    추가 항목

    images

    첨부 이미지

    리뷰에 첨부하는 이미지

    tags

    해시태그

    rating

    평점

    use_share

    SNS 공유 여부

    리뷰의 SNS 공유 여부

    T : 공유함
    F : 공유안함

    display

    게시 여부

    리뷰의 게시 여부

    T : 게시함
    F : 게시안함

    deleted

    삭제 여부

    리뷰의 삭제 여부

    T : 삭제됨
    F : 삭제되지 않음

    List all customers reviews

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/reviews'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/reviews' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "reviews": [
            {
                "shop_no": 1,
                "product_no": 10,
                "review_no": 1,
                "order_id": "20180116-0000001",
                "nickname": "",
                "title": "#recommend #popular product.",
                "content": "#recommend #popular product.",
                "content_text_length": 16,
                "input_channel": "P",
                "writer": "John Doe",
                "writing_id": "user1",
                "created_date": "2018-01-17T17:57:40+09:00",
                "comment_count": 0,
                "like_count": 0,
                "share_count": 0,
                "hit_count": 0,
                "additional_information": [
                    {
                        "item_name": "Height",
                        "item_value": "170~180"
                    },
                    {
                        "item_name": "Size",
                        "item_value": "95"
                    }
                ],
                "images": [
                    {
                        "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                        "size": 143543,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "thumb": {
                            "size": 222879,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                            "width": 300,
                            "height": 409,
                            "tiny": {
                                "size": 12104,
                                "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                            }
                        }
                    },
                    {
                        "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                        "size": 83742,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "thumb": {
                            "size": 7779,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                            "width": 300,
                            "height": 200,
                            "tiny": {
                                "size": 1983,
                                "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                            }
                        }
                    }
                ],
                "tags": [
                    "cool",
                    "best"
                ],
                "rating": 3,
                "use_share": "F",
                "display": "T",
                "deleted": "T"
            },
            {
                "shop_no": 1,
                "product_no": 12,
                "review_no": 2,
                "order_id": "20180108-0000039",
                "nickname": "",
                "title": "Good Product.",
                "content": "Good!",
                "content_text_length": 8,
                "input_channel": "P",
                "writer": "John Doe",
                "writing_id": "user1",
                "created_date": "2018-01-08T11:46:56+09:00",
                "comment_count": 0,
                "like_count": 0,
                "share_count": 0,
                "hit_count": 0,
                "additional_information": "",
                "images": null,
                "tags": [],
                "rating": 5,
                "use_share": "T",
                "display": "T",
                "deleted": "F"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 읽기권한 (READ_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no

    리뷰 번호

    writing_id
    Required

    작성자 회원 아이디

    created_start_date

    날짜
    timezone

    작성일 검색 시작일

    리뷰 작성일 기준 검색의 검색 시작일
    검색 종료일과 같이 사용해야함

    created_end_date

    날짜
    timezone

    작성일 검색 종료일

    리뷰 작성일 기준 검색의 검색 종료일
    검색 시작일과 같이 사용해야함

    deleted

    삭제된 리뷰글 여부

    T : 삭제됨
    F : 삭제되지 않음

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    T : 댓글이 작성된 리뷰만 검색
    F : 댓글이 작성되지 않은 리뷰만 검색

    has_image

    이미지가 첨부된 리뷰만 검색

    T : 이미지가 첨부된 리뷰만 검색
    F : 이미지가 첨부되지 않은 리뷰만 검색

    search_key

    검색 대상 항목

    writer : 작성자명
    writing_id : 작성자 회원 아이디
    content : 리뷰 내용
    product_no : 상품 번호
    product_name : 상품명
    product_code : 상품 코드

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    limit

    최소값: [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    최소값: [0]

    목록을 가져올 시작 위치

    조회결과 시작위치

    Get a customers review

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/reviews/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/user1/reviews/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "review": {
            "shop_no": 1,
            "product_no": 10,
            "review_no": 1,
            "order_id": "20180116-0000001",
            "nickname": "",
            "title": "#recommend #popular product.",
            "content": "#recommend #popular product.",
            "content_text_length": 28,
            "input_channel": "P",
            "writer": "John Doe",
            "writing_id": "user1",
            "created_date": "2018-01-17T17:57:40+09:00",
            "comment_count": 0,
            "like_count": 0,
            "share_count": 0,
            "hit_count": 0,
            "additional_information": [
                {
                    "item_name": "Height",
                    "item_value": "170~180"
                },
                {
                    "item_name": "Size",
                    "item_value": "95"
                }
            ],
            "images": [
                {
                    "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                    "size": 143543,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                    "thumb": {
                        "size": 222879,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "width": 300,
                        "height": 409,
                        "tiny": {
                            "size": 12104,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                        }
                    }
                },
                {
                    "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                    "size": 83742,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                    "thumb": {
                        "size": 7779,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "width": 300,
                        "height": 200,
                        "tiny": {
                            "size": 1983,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                        }
                    }
                }
            ],
            "tags": [
                "recommend",
                "popular"
            ],
            "rating": 4.5,
            "use_share": "F",
            "display": "T",
            "deleted": "T"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 읽기권한 (READ_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    review_no
    Required

    리뷰 번호

    Count all customers reviews

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customers/{#id}/reviews/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customers/user1/reviews/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 읽기권한 (READ_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    created_start_date

    날짜
    timezone

    작성일 검색 시작일

    리뷰 작성일 기준 검색의 검색 시작일
    검색 종료일과 같이 사용해야함

    created_end_date

    날짜
    timezone

    작성일 검색 종료일

    리뷰 작성일 기준 검색의 검색 종료일
    검색 시작일과 같이 사용해야함

    deleted

    삭제된 리뷰글 여부

    T : 삭제됨
    F : 삭제되지 않음

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    T : 댓글이 작성된 리뷰만 검색
    F : 댓글이 작성되지 않은 리뷰만 검색

    has_image

    이미지가 첨부된 리뷰만 검색

    T : 이미지가 첨부된 리뷰만 검색
    F : 이미지가 첨부되지 않은 리뷰만 검색

    search_key

    검색 대상 항목

    writer : 작성자명
    writing_id : 작성자 회원 아이디
    content : 리뷰 내용
    product_no : 상품 번호
    product_name : 상품명
    product_code : 상품 코드

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    Customersprivacy

    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 : 수신안함

    wedding_anniversary

    날짜

    결혼기념일

    해당 회원의 결혼기념일

    birthday

    날짜

    생일

    해당 회원의 생일

    solar_calendar

    양력여부

    생일이 양력인지 음력인지 여부

    T : 양력
    F : 음력

    total_mileage

    총 적립금

    해당 회원의 총 적립금

    available_mileage

    가용 적립금

    해당 회원의 사용 가능한 적립금

    used_mileage

    사용 적립금

    해당 회원이 사용한 적립금

    address1

    최대글자수 : [255자]

    기본 주소

    해당 회원의 기본주소(시/군/도)

    address2

    최대글자수 : [255자]

    상세 주소

    해당 회원의 상세주소

    group_no

    회원등급번호

    해당 회원의 회원등급의 번호

    job_class

    직종

    해당 회원의 직종

    job

    직업

    해당 회원의 직업

    zipcode

    최대글자수 : [14자]

    우편번호

    created_date

    timezone

    가입일

    해당 회원의 가입일시

    member_authentication

    회원인증여부

    회원 인증여부. 인증에 따라 회원은 4종류로 구분된다. 인증회원을 특별관리회원으로 설정할 경우 해당 회원은 가장 마지막에 설정한 특별관리회원으로 표시된다.

    T : 인증
    F : 미인증
    B : 특별관리회원
    J : 14세미만회원

    use_blacklist

    불량회원설정

    불량회원 여부. 불량회원일 경우 불량회원 타입에 따라 상품구매 차단, 로그인 차단, 로그인과 상품구매 모두를 차단할 수 있음.

    T : 설정함
    F : 설정안함

    pointfy_member

    통합멤버쉽 회원여부

    해당 회원의 통합멤버쉽 이용 여부. 통합멤버쉽은 브랜드가 하나이고 오프라인 매장과의 통합을 원하는 경우 이용할 수 있는 서비스임.

    T : 설정함
    F : 설정안함

    blacklist_type

    불량회원 차단설정

    해당 회원의 불량회원 타입. 불량회원 타입에 따라 상품구매 차단, 로그인 차단, 로그인과 상품구매 모두를 차단할 수 있음.

    P : 상품구매차단
    L : 로그인차단
    A : 로그인&상품구매 차단

    last_login_date

    timezone

    최근 접속일시

    해당 회원의 최종 로그인 일시

    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 : 국제운전면허증

    corporate_name

    법인명

    해당 회원의 법인명

    nationality

    국적

    해당 회원이 "외국인 회원"일 경우, 해당 회원의 국적

    shop_name

    쇼핑몰명

    해당 회원의 상호명

    country_code

    국가코드

    해당 회원이 가입시 입력한 국가

    use_mobile_app

    모바일앱 사용여부

    해당 회원의 모바일앱 사용여부

    T : 사용
    F : 사용안함

    available_deposit

    가용 예치금

    상세 조회시에만 확인 가능하다.

    additional_information

    추가항목

    해당 회원의 추가항목
    회원 상세 조회 API에서만 확인 가능하다.

    상세 조회시에만 확인 가능하다.

    List all customersprivacy

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customersprivacy": [
            {
                "shop_no": 1,
                "member_id": "sampleid",
                "name": "John Doe",
                "name_english": "John Doe",
                "name_phonetic": "John Doe",
                "phone": "02-0000-0000",
                "cellphone": "010-000-0000",
                "email": "sample@sample.com",
                "wedding_anniversary": "2018-06-20",
                "birthday": "2018-06-20",
                "solar_calendar": "T",
                "total_mileage": "0.00",
                "available_mileage": "0.00",
                "used_mileage": "0.00",
                "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
                "address2": "Professional Construction Hall",
                "group_no": 1,
                "job": "self-employment",
                "job_class": "service",
                "zipcode": "07071",
                "created_date": "2018-01-18T11:19:27+09:00",
                "member_authentication": "T",
                "use_blacklist": "F",
                "pointfy_member": "F",
                "blacklist_type": "",
                "last_login_date": "2018-01-18T11:19:27+09:00",
                "member_authority": "C",
                "nick_name": "nickname",
                "recommend_id": "testid2",
                "residence": "Seoul",
                "interest": "animation, movie\/theater",
                "gender": "F",
                "member_type": "p",
                "company_type": "p",
                "foreigner_type": "f",
                "corporate_name": "Sample company",
                "nationality": "Korea",
                "shop_name": "Sample Shop",
                "country_code": "KR",
                "use_mobile_appp": "F"
            },
            {
                "shop_no": 1,
                "member_id": "sampleid01",
                "name": "Jane Doe",
                "name_english": "Jane Doe",
                "name_phonetic": "Jane Doe",
                "phone": "02-0000-0000",
                "cellphone": "010-000-0000",
                "email": "sample@sample.com",
                "wedding_anniversary": "2018-06-20",
                "birthday": "2018-06-20",
                "solar_calendar": "T",
                "total_mileage": "0.00",
                "available_mileage": "0.00",
                "used_mileage": "0.00",
                "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
                "address2": "Professional Construction Hall",
                "group_no": 1,
                "job": "self-employment",
                "job_class": "service",
                "zipcode": "07071",
                "created_date": "2018-01-18T11:19:27+09:00",
                "member_authentication": "T",
                "use_blacklist": "F",
                "pointfy_member": "F",
                "blacklist_type": "",
                "last_login_date": "2018-01-18T11:19:27+09:00",
                "member_authority": "C",
                "nick_name": "nickname",
                "recommend_id": "testid2",
                "residence": "Seoul",
                "interest": "animation, movie\/theater",
                "gender": "F",
                "member_type": "p",
                "company_type": "p",
                "foreigner_type": "f",
                "corporate_name": "Sample company",
                "nationality": "Korea",
                "shop_name": "Sample Shop",
                "country_code": "KR",
                "use_mobile_appp": "F"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 개인정보 읽기권한 (READ_PRIVACY)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    search_type

    검색 타입

    회원 검색을 회원정보 기반으로 할지 가입일 기준으로 할지 선택하여 검색할 수 있다.
    가입일 기준으로 검색할 경우 offset과 관계 없이 전체 회원을 검색할 수 있다.

    ※ 가입일 기준 사용시 created_start_date 외의 모든 검색 조건은 사용할 수 없다.

    customer_info : 회원정보 기반 검색
    created_date : 가입일 기준 검색

    DEFAULT customer_info

    created_start_date

    날짜
    timezone

    가입일 기준 검색시 검색 시작일

    search_type이 created_date 일 경우 가입일 기준의 검색 시작일. 해당 가입일 이후에 가입한 회원을 검색할 수 있다.

    member_id

    최대글자수 : [20자]

    회원아이디

    회원 아이디

    news_mail

    뉴스메일 수신여부

    이메일을 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. '절대수신안함' 시 주요 메일을 포함하여 모든 메일을 수신하지 않음.

    T : 수신
    F : 수신안함

    sms

    SMS 수신여부

    SMS를 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함.

    T : 수신
    F : 수신안함

    group_no

    회원등급번호

    해당 회원의 회원등급의 번호

    search_field

    검색필드

    조회하고자 하는 회원의 검색필드.

    id : 아이디
    name : 이름
    hp : 핸드폰
    tel : 전화번호
    mail : 이메일

    keyword

    검색어

    조회하고자 하는 회원의 검색필드에 대한 검색어를 입력함.
    ex) search_field : mail
    keyword : cafe24@cafe24.com

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

    date_type

    검색날짜 유형

    조회의 기준이 되는 검색필드. '회원가입일' 기준으로 검색할 경우 검색시작일과 검색종료일의 기간은 회원가입일 기준이 됨.

    join : 회원가입일
    login : 최근접속일
    age : 생년월일

    start_date

    날짜
    timezone

    검색 시작일

    특정 조회기준에 대한 검색 시작일.
    검색 종료일과 같이 사용해야함.
    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색함.
    ex) 2018-12-31 00:00:00

    end_date

    날짜
    timezone

    검색 종료일

    특정 조회기준에 대한 검색 종료일.
    검색 시작일과 같이 사용해야함.
    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색함.
    ex) 2018-12-31 23:59:59

    member_type

    회원타입

    해당 회원의 회원 타입

    vip : 특별관리회원
    poor : 블랙리스트
    pointfy : 통합멤버쉽 사용자

    residence

    지역코드

    해당 회원의 주거지역

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

    gender

    성별

    해당 회원의 성별

    M : 남자
    F : 여자

    member_authority

    회원권한구분

    회원 권한 구분. 회원 권한은 일반회원, 대표운영자, 부운영자, 공급사로 권한이 구분됨.

    C : 일반회원
    P : 대표 운영자
    A : 부운영자
    S : 공급사

    DEFAULT C

    limit

    최대값: [1000]

    조회결과 최대건수

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

    DEFAULT 30

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Count all customersprivacy

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    기본스펙

    Property Description
    SCOPE 개인정보 읽기권한 (READ_PRIVACY)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    search_type

    검색 타입

    회원 검색을 회원정보 기반으로 할지 가입일 기준으로 할지 선택하여 검색할 수 있다.
    가입일 기준으로 검색할 경우 offset과 관계 없이 전체 회원을 검색할 수 있다.

    ※ 가입일 기준 사용시 created_start_date 외의 모든 검색 조건은 사용할 수 없다.

    customer_info : 회원정보 기반 검색
    created_date : 가입일 기준 검색

    DEFAULT customer_info

    created_start_date

    날짜
    timezone

    가입일 기준 검색시 검색 시작일

    search_type이 created_date 일 경우 가입일 기준의 검색 시작일. 해당 가입일 이후에 가입한 회원을 검색할 수 있다.

    member_id

    최대글자수 : [20자]

    회원아이디

    회원 아이디

    news_mail

    뉴스메일 수신여부

    이메일을 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함. '절대수신안함' 시 주요 메일을 포함하여 모든 메일을 수신하지 않음.

    T : 수신
    F : 수신안함

    sms

    SMS 수신여부

    이벤트 SMS를 수신할지 여부. '수신거부' 시 광고, 영리성 목적 외 서비스에 필요한 주요 메일은 정상적으로 수신함.

    T : 수신
    F : 수신안함

    group_no

    회원등급번호

    해당 회원의 회원등급의 번호

    search_field

    검색필드

    조회하고자 하는 회원의 검색필드.

    id : 아이디
    name : 이름
    hp : 핸드폰
    tel : 전화번호
    mail : 이메일

    keyword

    검색어

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

    date_type

    검색날짜 유형

    join : 회원가입일
    login : 최근접속일
    age : 생년월일

    start_date

    날짜
    timezone

    검색 시작일

    특정 조회기준에 대한 검색 시작일.
    검색 종료일과 같이 사용해야함.
    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색함.
    ex) 2018-12-31 00:00:00

    end_date

    날짜
    timezone

    검색 종료일

    특정 조회기준에 대한 검색 종료일.
    검색 시작일과 같이 사용해야함.
    검색 시작일과 종료일이 동일할 경우 해당 날짜로만 검색함.
    ex) 2018-12-31 23:59:59

    member_type

    회원타입

    해당 회원의 회원 타입

    vip : 특별관리회원
    poor : 블랙리스트
    pointfy : 통합멤버쉽 사용자

    residence

    지역코드

    해당 회원의 주거지역

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

    gender

    성별

    해당 회원의 성별

    M : 남자
    F : 여자

    member_authority

    회원권한구분

    회원 권한 구분. 회원 권한은 일반회원, 대표운영자, 부운영자, 공급사로 권한이 구분됨.

    C : 일반회원
    P : 대표 운영자
    A : 부운영자
    S : 공급사

    DEFAULT C

    Get a customersprivacy

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/customersprivacy/sampleid' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "customersprivacy": {
            "shop_no": 1,
            "member_id": "sampleid",
            "name": "John Doe",
            "name_english": "John Doe",
            "name_phonetic": "John Doe",
            "phone": "02-0000-0000",
            "cellphone": "010-000-0000",
            "email": "sample@sample.com",
            "wedding_anniversary": "2018-06-20",
            "birthday": "2018-06-20",
            "solar_calendar": "T",
            "total_mileage": "0.00",
            "available_mileage": "0.00",
            "used_mileage": "0.00",
            "available_deposit": "0.00",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "group_no": 1,
            "job": "self-employment",
            "job_class": "service",
            "zipcode": "07071",
            "created_date": "2018-01-18T11:19:27+09:00",
            "member_authentication": "T",
            "use_blacklist": "F",
            "pointfy_member": "F",
            "blacklist_type": "",
            "last_login_date": "2018-01-18T11:19:27+09:00",
            "member_authority": "C",
            "nick_name": "nickname",
            "recommend_id": "testid2",
            "residence": "Seoul",
            "interest": "animation, movie\/theater",
            "gender": "F",
            "member_type": "p",
            "company_type": "p",
            "foreigner_type": "f",
            "corporate_name": "Sample company",
            "nationality": "Korea",
            "shop_name": "Sample Shop",
            "country_code": "KR",
            "use_mobile_appp": "F",
            "additional_information": []
        }
    }
    

    기본스펙

    Property Description
    SCOPE 개인정보 읽기권한 (READ_PRIVACY)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    member_id
    Required

    최대글자수 : [20자]

    회원아이디

    회원 아이디

    Dashboard

    대시보드(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

    게시판 목록

    해당 몰의 게시판의 리스트

    Get dashboard

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/dashboard'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/dashboard' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "dashboard": [
            {
                "shop_no": 1,
                "daily_sales_stats": [
                    {
                        "title": "December 20",
                        "date": "2017-12-20",
                        "order_price": "0.00",
                        "payed_price": "0.00",
                        "refund_price": "0.00",
                        "order_count": 0,
                        "payed_count": 0,
                        "refund_count": 0,
                        "preparing_products_count": 0,
                        "preparing_shipment_count": 0,
                        "waiting_shipment_count": 0,
                        "delivering_count": 0,
                        "shipend_count": 0,
                        "canceled_count": 0,
                        "returned_count": 0,
                        "exchanged_count": 0,
                        "ordered_total_count": 0
                    },
                    {
                        "title": "December 21 (Today)",
                        "date": "2017-12-21",
                        "order_price": "0.00",
                        "payed_price": "0.00",
                        "refund_price": "0.00",
                        "order_count": 0,
                        "payed_count": 0,
                        "refund_count": 0,
                        "preparing_products_count": 0,
                        "preparing_shipment_count": 0,
                        "waiting_shipment_count": 0,
                        "delivering_count": 0,
                        "shipend_count": 0,
                        "canceled_count": 0,
                        "returned_count": 0,
                        "exchanged_count": 0,
                        "ordered_total_count": 0
                    }
                ],
                "weekly_sales_stats": {
                    "ordered_total_price": "0.00",
                    "payed_total_price": "0.00",
                    "refunded_total_price": "0.00",
                    "ordered_count": 0,
                    "payed_count": 0,
                    "refunded_count": 0,
                    "ordered_average_total_price": "0.00",
                    "payed_average_total_price": "0.00",
                    "refunded_average_total_price": "0.00",
                    "ordered_average_count": 0,
                    "payed_average_count": 0,
                    "refunded_average_count": 0
                },
                "monthly_sales_stats": {
                    "ordered_total_price": "0.00",
                    "payed_total_price": "0.00",
                    "refunded_total_price": "0.00",
                    "ordered_count": 0,
                    "payed_count": 0,
                    "refunded_count": 0,
                    "ordered_average_total_price": "0.00",
                    "payed_average_total_price": "0.00",
                    "refunded_average_total_price": "0.00",
                    "ordered_average_count": 0,
                    "payed_average_count": 0,
                    "refunded_average_count": 0
                },
                "sold_out_products_count": 0,
                "new_members_count": 0,
                "board_list": [
                    {
                        "type ": "B ",
                        "board_no ": 1,
                        "board_name ": "공지사항 ",
                        "new_registered_count ": 0,
                        "page_url ": "\/disp\/admin\/mobile\/index#\/bulletins?board_no=1"
                    },
                    {
                        "type ": "B ",
                        "board_no ": 2,
                        "board_name ": "뉴스\/이벤트 ",
                        "new_registered_count ": 0,
                        "page_url ": "\/disp\/admin\/mobile\/index#\/bulletins?board_no=2"
                    }
                ]
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상점 읽기권한 (READ_STORE)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    Mains

    Mains Entity 관계도

    메인분류(Mains)는 쇼핑몰의 상품을 메인화면에 진열할 수 있는 상품 분류입니다.

    Mains properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    module_code

    모듈 코드

    각 메인분류에 지정된 모듈 코드

    display_group

    메인분류 번호

    group_name

    메인분류 명

    메인분류 생성 당시 지정한 분류명

    soldout_sort_type

    품절상품진열

    품절상품을 진열할 위치

    B : 품절상품 맨 뒤로
    F : 품절상품 맨 앞으로
    N : 품절상품 상관없음

    List all mains

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/mains'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "mains": [
            {
                "shop_no": 1,
                "module_code": "product_listmain_1",
                "display_group": 2,
                "group_name": "Main Recommendations",
                "soldout_sort_type": "B"
            },
            {
                "shop_no": 1,
                "module_code": "product_listmain_2",
                "display_group": 3,
                "group_name": "New Arrival",
                "soldout_sort_type": "F"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품분류 읽기권한 (READ_CATEGORY)
    호출건수 제한 30

    Mains products

    Mains products properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

    product_name

    상품명

    display_order

    진열 순서

    상품의 진열 순위.

    메인진열에서 표시되는 순서를 나타낸다. 표시되는 순서는 진열되어있던 상품이 삭제된 경우 순차적으로 표시되지 않을 수 있다.
    예) 4번째 상품이 삭제된 경우 1,2,3,5,6,7… 같은 순서로 표시될 수 있음.

    진열순위를 고정한 상품의 경우 진열 순위에 숫자 9,999,999 이 더해진다.
    예) 진열순위 3의 상품(display_order=3)을 고정 시 display_order=10,000,002

    List all mains products

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/mains/{#id}/products'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "products": [
            {
                "shop_no": 1,
                "product_no": 7,
                "product_name": "product_name",
                "display_order": 1
            },
            {
                "shop_no": 1,
                "product_no": 8,
                "product_name": "product_name2",
                "display_order": 10000002
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    display_group
    Required

    메인분류 번호

    Count all mains products

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/mains/{#id}/products/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    display_group
    Required

    메인분류 번호

    Create a mains product

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/mains/{#id}/products'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "product_no": [
                7,
                8,
                9
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": [
                7,
                8,
                9
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    display_group
    Required

    메인분류 번호

    product_no
    Required

    상품번호

    Update a mains product

    메인진열 상품 수정은 순서 변경만 가능하며 해당 API를 통해 메인진열에 상품을 추가하거나 삭제하는 동작은 지원하지 않습니다. 변경 전 List all Mains products API를 통해 메인진열 상품 목록을 조회하신 다음, 조회한 항목 그대로 순서만 변경하여 수정 API에 추가해주세요.

    최대 200개의 상품이 진열되어있는 메인분류만 진열 순서 조정이 가능합니다.

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/mains/{#id}/products'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "product_no": [
                7,
                8,
                9
            ],
            "fix_product_no": [
                8,
                9
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": [
                7,
                8,
                9
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    display_group
    Required

    메인분류 번호

    product_no
    Required

    상품번호

    요청한 상품번호의 순서 대로 진열순위가 지정

    fix_product_no

    진열순위 고정 상품번호

    진열순위를 고정하고자 하는 상품번호를 지정

    Delete a mains product

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/mains/{#id}/products/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/mains/2/products/7' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": 7
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    display_group
    Required

    메인분류 번호

    product_no
    Required

    상품번호

    Manufacturers

    제조사(Manufacturers)는 상품의 "제작정보" 중 제조사에 입력하는 정보를 의미합니다. 제조사는 상품을 제작, 생산한 주체를 나타내며, 상품을 구분하는 판매분류의 하나입니다. 상품은 반드시 하나의 제조사를 갖고 있습니다.(미지정시 "자체제조사"를 사용함)
    제조사(Manufacturers)의 {#id}는 "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

    우편번호

    제조사의 사업장 우편번호.

    상세 조회시에만 확인 가능하다.

    address1

    최대글자수 : [255자]

    기본 주소

    제조사의 사업장 주소(시/군/구 단위 표기)

    상세 조회시에만 확인 가능하다.

    address2

    최대글자수 : [255자]

    상세 주소

    제조사의 사업장 주소(상세 주소 표기)

    상세 조회시에만 확인 가능하다.

    created_date

    timezone

    생성일

    상세 조회시에만 확인 가능하다.

    List all manufacturers

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "manufacturers": [
            {
                "shop_no": 1,
                "manufacturer_code": "M0000000",
                "manufacturer_name": "Sample Manufacturer",
                "president_name": "Sample Administrator",
                "use_manufacturer": "T"
            },
            {
                "shop_no": 1,
                "manufacturer_code": "M000000C",
                "manufacturer_name": "Sample Manufacturer",
                "president_name": "Sample Administrator",
                "use_manufacturer": "F"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 읽기권한 (READ_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    manufacturer_code

    제조사 코드

    조회하고자 하는 제조사의 코드.

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

    manufacturer_name

    제조사명

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

    use_manufacturer

    제조사 사용여부

    T : 사용함
    F : 사용안함

    limit

    최대값: [100]

    조회결과 최대건수

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

    DEFAULT 10

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Get a manufacturer

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/M0000000' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "manufacturer": {
            "shop_no": 1,
            "manufacturer_code": "M0000000",
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "created_date": "2018-09-01T15:00:00+09:00",
            "use_manufacturer": "T"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 읽기권한 (READ_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    manufacturer_code
    Required

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

    제조사 코드

    Count all manufacturers

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 읽기권한 (READ_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    manufacturer_code

    제조사 코드

    조회하고자 하는 제조사의 코드.

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

    manufacturer_name

    제조사명

    검색어를 제조사명에 포함하고 있는 공급사 검색(대소문자 구분 없음)

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

    use_manufacturer

    제조사 사용여부

    T : 사용함
    F : 사용안함

    Create a manufacturer

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "use_manufacturer": "T"
        }
    }'
    

    Response example:

    {
        "manufacturer": {
            "shop_no": 1,
            "manufacturer_code": "M0000000",
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "use_manufacturer": "T"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 쓰기권한 (WRITE_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    manufacturer_name
    Required

    최대글자수 : [50자]

    제조사명

    president_name
    Required

    최대글자수 : [30자]

    대표자명

    email

    최대글자수 : [255자]
    이메일

    이메일

    phone

    최대글자수 : [20자]
    전화번호

    전화번호

    homepage

    최대글자수 : [255자]

    홈페이지

    zipcode

    우편번호

    address1

    최대글자수 : [255자]

    기본 주소

    address2

    최대글자수 : [255자]

    상세 주소

    use_manufacturer

    사용여부

    T : 사용함
    F : 사용안함

    Update a manufacturer

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/manufacturers/M000000A' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "use_manufacturer": "T"
        }
    }'
    

    Response example:

    {
        "manufacturer": {
            "shop_no": 1,
            "manufacturer_code": "M000000A",
            "manufacturer_name": "Sample Manufacturer",
            "president_name": "Sample User",
            "email": "sample@sample.com",
            "phone": "010-000-0000",
            "homepage": "http:\/\/sample.com",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "use_manufacturer": "T"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 쓰기권한 (WRITE_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    manufacturer_code
    Required

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

    제조사 코드

    manufacturer_name

    최대글자수 : [50자]

    제조사명

    president_name

    최대글자수 : [30자]

    대표자명

    email

    최대글자수 : [255자]
    이메일

    이메일

    phone

    최대글자수 : [20자]
    전화번호

    전화번호

    homepage

    최대글자수 : [255자]

    홈페이지

    zipcode

    우편번호

    address1

    최대글자수 : [255자]

    기본 주소

    address2

    최대글자수 : [255자]

    상세 주소

    use_manufacturer

    사용여부

    T : 사용함
    F : 사용안함

    Mileage

    Mileage properties

    Attribute Description
    amount

    적립금 증감액

    1회당 최대 1,000,000원 이하까지 적립금을 지급할 수 있음.
    가용 적립금보다 큰 금액을 차감할 수 없다.

    type

    적립금 증가/차감 여부

    적립금을 증가시킬지 차감시킬지 여부를 선택할 수 있다.

    reason

    적립 사유

    적립금을 증가/차감하는 사유를 입력할 수 있다.

    Create a mileage

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/mileage'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/mileage' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "member_id": "testmember",
            "amount": "10.00",
            "type": "increase",
            "reason": "test"
        }
    }'
    

    Response example:

    {
        "mileage": {
            "amount": "10.00",
            "type": "increase",
            "reason": "test"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 적립금 쓰기권한 (WRITE_MILEAGE)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    멀티쇼핑몰 구분을 위해 사용하는 멀티쇼핑몰 번호.
    SMS는 한국어 멀티쇼핑몰에서만 발송 가능하다.

    DEFAULT 1

    member_id
    Required

    최대글자수 : [20자]

    회원아이디

    회원 아이디

    amount
    Required

    최소값: [0]

    적립금 증감액

    1회당 최대 1,000,000원 이하까지 적립금을 지급할 수 있음.
    가용 적립금보다 큰 금액을 차감할 수 없다.

    type
    Required

    적립금 증가/차감 여부

    적립금을 증가시킬지 차감시킬지 여부를 선택할 수 있다.

    increase : 증가
    decrease : 차감

    reason

    적립 사유

    적립금을 증가/차감하는 사유를 입력할 수 있다.

    Orders

    Orders Entity 관계도

    주문(order)은 쇼핑몰에서 쇼핑몰 고객이 상품을 구입하기 위해 쇼핑몰에 요청한 내역입니다. 쇼핑몰 운영자는 결제가 완료된 주문 정보를 참고하여 쇼핑몰 고객에게 물건을 배송합니다. 주문 정보에는 주문과 결제를 진행한 주문자의 정보와 상품을 배송 받을 수령자 정보가 포함됩니다.

    주문(Orders)의 {#id}는 "order_id"입니다.

    주문은 다음과 같은 Entity를 하위 Entity로 갖고 있습니다.
    품주(Items)
    수령자정보(Receivers)

    Orders properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    currency

    화폐단위

    해당 멀티쇼핑몰의 화폐단위

    order_id

    주문번호

    주문번호

    market_id

    마켓 구분값

    가격 비교 사이트를 통하여 마켓 등에서 상품 구매 시 해당 사이트를 구분하기 위한 ID

    market_order_info

    마켓 기타 정보

    마켓 또는 주문경로에 대한 기타 정보

    buyer_name

    주문자 이름

    주문자 이름. 입금자 혹은 수령자 이름과는 다를 수 있음.

    buyer_email

    주문자 이메일

    주문자 이메일. 입금자 혹은 수령자 이메일과는 다를 수 있음.

    buyer_phone

    주문자 일반 전화

    주문자 일반전화. 입금자 혹은 수령자 일반전화와는 다를 수 있음.

    buyer_cellphone

    주문자 휴대 전화

    주문자 휴대전화. 입금자 혹은 수령자 휴대전화와는 다를 수 있음.

    member_id

    회원아이디

    회원아이디

    member_authentication

    회원인증여부

    회원 인증여부. 인증여부에 따라 3가지로 회원타입이 나눠짐.

    T : 승인
    B : 특별관리회원
    J : 14세미만회원

    billing_name

    결제자명

    입금자 이름. 주문자 혹은 수령자 이름과는 다를 수 있음.

    bank_code

    은행코드

    입금자 은행코드

    bank_code_name

    입금자 은행명

    입금자 은행명

    payment_method

    결제수단 코드

    주문자가 이용한 결제수단의 코드

    payment_method_name

    결제수단명

    주문자가 이용한 결제수단의 이름

    payment_method_icon

    결제수단 아이콘

    결제수단 아이콘

    payment_gateway_name

    PG 이름

    주문자가 이용한 PG 사의 이름

    paid

    결제 여부

    결제가 완료되었는지 여부

    T : 결제
    F : 미결제

    order_date

    timezone

    주문일

    주문일

    first_order

    최초 주문여부

    해당 주문이 최초 주문인지 여부

    T : 최초 주문
    F : 최초 주문 아님

    payment_date

    timezone

    결제일

    결제일

    order_from_mobile

    모바일 구분

    주문이 모바일에서 이루어졌는지 여부

    T : 모바일 주문
    F : 모바일 주문 아님

    order_price_amount

    주문금액

    주문금액

    use_escrow

    에스크로 사용여부

    에스크로를 사용했는지 여부

    T : 에스크로 사용
    F : 에스크로 미사용

    customer_group_no_when_ordering

    주문시 회원등급

    주문 당시의 회원등급

    membership_discount_amount

    회원할인금액

    회원에 대하여 할인해준 금액

    app_discount_amount

    앱 주문할인금액

    actual_payment_amount

    실결제금액

    실 결제금액. 고객이 실제 지불한 금액으로 취소, 교환, 반품등을 할 경우 실 결제금액은 변경될 수 있음.

    mileage_spent_amount

    적립금사용금액

    적립금 사용금액

    bank_account_no

    계좌번호

    해당 주문건에 대한 쇼핑몰의 계좌번호

    market_customer_id

    마켓 주문자 아이디

    마켓 주문자 아이디

    payment_amount

    결제금액 (초기 지불완료 금액)

    결제금액. 최초에 결제된 금액으로 변경되지 않음.

    cancel_date

    timezone

    주문취소일

    주문취소일

    inflow_name

    유입채널명

    유입채널명

    inflow_id

    유입채널 ID

    유입채널 ID

    order_place_name

    주문경로 텍스트

    order_place_id

    주문경로

    payment_confirmation

    후불결제 입금확인 가능 여부

    입금확인 여부

    T : 입금확인
    F : 입금미확인

    postpay_commission

    후불결제수수료

    후불결제수수료

    postpay

    후불결제여부

    후불결제여부

    T : 후불결제
    F : 후불결제 아님

    shipping_fee

    배송비

    배송비

    shipping_type

    배송 유형

    배송 유형. 국내배송인지 해외배송인지 둘 다 가능한지 여부.

    A : 국내
    B : 국내&해외
    C : 해외

    shipping_type_text

    배송 유형명

    배송 유형의 설명. 국내배송인지 해외배송인지 둘 다 가능한지 여부.

    shipping_status

    배송상태

    배송상태

    F : 배송전
    M : 배송중
    T : 배송완료
    W : 배송보류

    wished_delivery_date

    희망배송일

    희망 배송일

    wished_delivery_time

    희망배송시간

    희망배송 시간

    wished_carrier_id

    희망배송사 코드

    희망배송사 코드

    return_confirmed_date

    timezone

    반품승인일시

    반품승인일시

    total_supply_price

    총 공급가액

    총 공급가액

    additional_order_info_list

    주문서 추가항목

    store_pickup

    매장수령여부

    매장수령여부

    T : 매장수령
    F : 매장수령 아님

    easypay_name

    간편결제 결제사 이름

    간편결제 결제사 이름

    loan_status

    여신상태

    여신상태

    OK : GOOD
    NG : NOT GOOD
    ER : ERROR

    shipping_message

    배송 메세지

    배송메세지

    items

    품주 엔티티 (Item Entity)


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    receivers

    수령자정보 엔티티 (Receiver Entity)


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    buyer

    주문자정보 엔티티 (Buyer Entity)


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    List all orders

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders?start_date=2017-01-01&end_date=2017-12-31&order_status=N10,N20&date_type=pay_date' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "orders": [
            {
                "shop_no": "1",
                "currency": "KRW",
                "order_id": "20170710-0000013",
                "market_id": "self",
                "market_order_info": null,
                "buyer_name": "John Doe",
                "buyer_email": "sample@sample.com",
                "buyer_phone": "02-0000-0000",
                "buyer_cellphone": "010-0000-0000",
                "member_id": "sampleid",
                "member_authentication": "T",
                "customer_group_no_when_ordering": 1,
                "billing_name": "Test",
                "bank_code": "bank_26",
                "bank_code_name": "Sample Bank",
                "payment_method": "card",
                "payment_method_name": "Card",
                "payment_method_icon": "<img src='\/\/img.echosting.cafe24.com\/icon\/ico_pay_card.gif' alt='Card' title='Card'>",
                "payment_gateway_name": "",
                "paid": "T",
                "order_date": "2018-07-04T11:21:35+09:00",
                "first_order": "T",
                "payment_date": "2018-07-04T11:21:35+09:00",
                "order_from_mobile": "F",
                "order_price_amount": "30000.00",
                "use_escrow": "F",
                "membership_discount_amount": "0.00",
                "app_discount_amount": "0.00",
                "actual_payment_amount": "30000.00",
                "mileage_spent_amount": "0.00",
                "bank_account_no": "12312422234",
                "market_customer_id": null,
                "payment_amount": "30000.00",
                "cancel_date": null,
                "inflow_name": "Zig Zag",
                "inflow_id": "zigzag",
                "order_place_name": "Naver Pay",
                "order_place_id": "NCHECKOUT",
                "payment_confirmation": null,
                "postpay_commission": "0.00",
                "postpay": "F",
                "shipping_fee": "0.00",
                "shipping_type": "A",
                "shipping_type_text": "Domestic Shipping",
                "shipping_status": "T",
                "wished_delivery_date": "",
                "wished_delivery_time": null,
                "wished_carrier_id": null,
                "return_confirmed_date": null,
                "total_supply_price": "27000",
                "additional_order_info_list": [
                    {
                        "id": "1",
                        "name": "addtional info1",
                        "value": "lorem ipsu",
                        "input_type": "A",
                        "product_type": "A",
                        "applied_product_list": [
                            "iPhone X"
                        ]
                    },
                    {
                        "id": "2",
                        "name": "addtional info2",
                        "value": "Green",
                        "input_type": "A",
                        "product_type": "A",
                        "applied_product_list": [
                            "iPhone X"
                        ]
                    }
                ],
                "store_pickup": "F",
                "easypay_name": "",
                "loan_status": null,
                "shipping_message": ""
            },
            {
                "shop_no": "1",
                "currency": "KRW",
                "order_id": "20170711-0000014",
                "market_id": "self",
                "market_order_info": null,
                "buyer_name": "John Doe",
                "buyer_email": "sample@sample.com",
                "buyer_phone": "02-0000-0000",
                "buyer_cellphone": "010-0000-0000",
                "member_id": "sampleid",
                "member_authentication": "T",
                "customer_group_no_when_ordering": 1,
                "billing_name": "123",
                "bank_code": "bank_26",
                "bank_code_name": "Sample Bank",
                "payment_method": "card",
                "payment_method_name": "Card",
                "payment_method_icon": "<img src='\/\/img.echosting.cafe24.com\/icon\/ico_pay_card.gif' alt='Card' title='Card'>",
                "payment_gateway_name": "",
                "paid": "T",
                "order_date": "2018-07-04T11:21:35+09:00",
                "first_order": "F",
                "payment_date": "2018-07-04T11:21:35+09:00",
                "order_from_mobile": "F",
                "order_price_amount": "10000.00",
                "use_escrow": "F",
                "membership_discount_amount": "0.00",
                "app_discount_amount": "0.00",
                "actual_payment_amount": "10000.00",
                "mileage_spent_amount": "0.00",
                "bank_account_no": "12312422234",
                "market_customer_id": null,
                "payment_amount": "10000.00",
                "cancel_date": null,
                "inflow_name": "Zig Zag",
                "inflow_id": "zigzag",
                "order_place_name": "Naver Pay",
                "order_place_id": "NCHECKOUT",
                "payment_confirmation": null,
                "postpay_commission": "0.00",
                "postpay": "F",
                "shipping_fee": "0.00",
                "shipping_type": "A",
                "shipping_type_text": "Domestic Shipping",
                "shipping_status": "M",
                "wished_delivery_date": "",
                "wished_delivery_time": null,
                "wished_carrier_id": null,
                "return_confirmed_date": null,
                "total_supply_price": "9000",
                "additional_order_info_list": [],
                "store_pickup": "F",
                "easypay_name": "",
                "loan_status": null,
                "shipping_message": ""
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 주문 읽기권한 (READ_ORDER)
    호출건수 제한 30

    요청사양

    Parameter Description
    items
    embed

    품주 엔티티 (Item Entity)


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    receivers
    embed

    수령자정보 엔티티 (Receiver Entity)


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    buyer
    embed

    주문자정보 엔티티 (Buyer Entity)


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    start_date
    Required

    날짜
    timezone

    검색 시작일

    검색을 시작할 기준일

    ※ API 성능을 보장하기 위해 검색 기간은 최근 3개월까지만 조회 가능함.

    end_date
    Required

    날짜
    timezone

    검색 종료일

    검색을 종료할 기준일
    검색 시작일과 같이 사용해야함.

    ※ ApI의 성능을 보장하기 위해 최근 3개월의 주문만 검색 가능함.

    order_id

    주문번호

    주문번호

    주문번호

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

    order_status

    주문상태

    주문상태. 주문 상태별로 각각의 코드가 있음.

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

    N00 : 입금전
    N10 : 상품 준비중
    N20 : 배송 준비중
    N21 : 배송대기
    N22 : 배송보류
    N30 : 배송중
    N40 : 배송완료
    C00 : 취소신청
    C10 : 취소 접수 - 관리자
    C34 : 취소처리중 - 환불전
    C36 : 취소처리중 - 환불보류
    C40 : 취소 완료
    C47 : 입금전취소 - 구매자
    C48 : 입금전취소 - 자동취소
    C49 : 입금전취소 - 관리자
    R00 : 반품신청
    R10 : 반품 접수
    R12 : 반품 보류
    R30 : 반품처리중 - 수거전
    R34 : 반품처리중 - 환불전
    R36 : 반품처리중 - 환불보류
    R40 : 반품완료 - 환불완료
    E00 : 교환신청
    E10 : 교환접수
    E12 : 교환보류
    E20 : 교환준비
    E30 : 교환처리중 - 수거전
    E32 : 교환처리중 - 입금전
    E34 : 교환처리중 - 환불전
    E36 : 교환처리중 - 환불보류
    E40 : 교환 완료

    member_type

    회원여부

    회원여부. 회원과 비회원 각각의 코드가 있음.

    2 : 회원
    3 : 비회원

    group_no

    회원등급번호

    회원등급

    buyer_name

    주문자명

    주문자 이름. 입금자 혹은 수령자 이름과는 다를 수 있음.

    receiver_name

    수령자명

    수령자 이름. 주문자 혹은 입금자 이름과는 다를 수 있음.

    receiver_address

    수령자주소

    수령자 주소. 주문자 혹은 입금자 주소와는 다를 수 있음.

    member_id

    회원아이디

    회원 아이디

    product_no

    상품번호

    상품 번호

    product_code

    상품코드

    상품 코드

    date_type

    검색날짜 유형

    검색을 위한 날짜 유형 기준. 기본값은 주문일로 설정되어 있음.

    order_date: 주문일
    pay_date: 결제일
    shipbegin_date: 배송시작일
    shipend_date: 배송완료일
    cancel_date: 주문취소일
    place_date: 발주일
    updatereceiver_date: 수령자정보 수정일
    cancel_complete_date: 취소완료일
    exchange_complete_date: 교환완료일
    return_complete_date: 반품완료일

    DEFAULT order_date

    supplier_id

    공급사 아이디

    limit

    최대값: [500]

    조회결과 최대건수

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

    DEFAULT 10

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Count all orders

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/count?shop_no=1&start_date=2017-01-01&end_date=2017-12-31&order_status=N10,N20&date_type=pay_date' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    기본스펙

    Property Description
    SCOPE 주문 읽기권한 (READ_ORDER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    start_date
    Required

    날짜
    timezone

    검색 시작일

    검색을 시작할 기준일

    end_date
    Required

    날짜
    timezone

    검색 종료일

    검색을 종료할 기준일
    검색 시작일과 같이 사용해야함.

    order_id

    주문번호

    주문번호

    주문번호

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

    order_status

    주문상태

    주문상태. 주문 상태별로 각각의 코드가 있음.

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

    N00 : 입금전
    N10 : 상품 준비중
    N20 : 배송 준비중
    N21 : 배송대기
    N22 : 배송보류
    N30 : 배송중
    N40 : 배송완료
    C00 : 취소신청
    C10 : 취소 접수 - 관리자
    C34 : 취소처리중 - 환불전
    C36 : 취소처리중 - 환불보류
    C40 : 취소 완료
    C47 : 입금전취소 - 구매자
    C48 : 입금전취소 - 자동취소
    C49 : 입금전취소 - 관리자
    R00 : 반품신청
    R10 : 반품 접수
    R12 : 반품 보류
    R30 : 반품처리중 - 수거전
    R34 : 반품처리중 - 환불전
    R36 : 반품처리중 - 환불보류
    R40 : 반품완료 - 환불완료
    E00 : 교환신청
    E10 : 교환접수
    E12 : 교환보류
    E20 : 교환준비
    E30 : 교환처리중 - 수거전
    E32 : 교환처리중 - 입금전
    E34 : 교환처리중 - 환불전
    E36 : 교환처리중 - 환불보류
    E40 : 교환 완료

    member_type

    회원여부

    회원여부. 회원과 비회원 각각의 코드가 있음.

    2 : 회원
    3 : 비회원

    group_no

    회원등급번호

    회원등급

    buyer_name

    주문자명

    주문자 이름. 입금자 혹은 수령자 이름과는 다를 수 있음.

    receiver_name

    수령자명

    수령자 이름. 주문자 혹은 입금자 이름과는 다를 수 있음.

    receiver_address

    수령자주소

    수령자 주소. 주문자 혹은 입금자 주소와는 다를 수 있음.

    member_id

    회원아이디

    회원 아이디

    product_no

    상품번호

    상품 번호

    product_code

    상품코드

    검색어를 상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요)

    date_type

    검색날짜 유형

    검색을 위한 날짜 유형 기준. 기본값은 주문일로 설정되어 있음.

    order_date: 주문일
    pay_date: 결제일
    shipbegin_date: 배송시작일
    shipend_date: 배송완료일
    cancel_date: 주문취소일
    place_date: 발주일
    updatereceiver_date: 수령자정보 수정일
    cancel_complete_date: 취소완료일
    exchange_complete_date: 교환완료일
    return_complete_date: 반품완료일

    DEFAULT order_date

    supplier_id

    공급사 아이디

    Orders buyer

    Orders buyer properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    member_id

    주문자 아이디

    주문자 아이디

    member_group_no

    주문당시 주문자 회원 등급 번호

    name

    주문자명

    email

    주문자 이메일

    해당 회원의 이메일

    phone

    주문자 일반 전화

    cellphone

    주문자 휴대 전화

    customer_notification

    고객 알림

    고객에게 알릴 문구

    updated_date

    timezone

    수정일

    user_id

    주문자 수정자 ID

    주문자정보를 수정한 사람의 ID

    user_name

    주문자 수정자 명

    주문자정보를 수정한 사람의 이름

    order_id

    주문번호

    주문번호

    Get an orders buyer

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders/{#id}/buyer'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20180903-0000243/buyer' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "buyer": {
            "shop_no": 1,
            "member_id": "sampleid",
            "member_group_no": 1,
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample",
            "updated_date": "2018-09-03T17:20:49+09:00",
            "user_id": "sampleid",
            "user_name": "John Doe"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 주문 읽기권한 (READ_ORDER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    주문번호

    주문번호

    Update an orders buyer

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/orders/{#id}/buyer'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20180903-0000243/buyer' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample"
        }
    }'
    

    Response example:

    {
        "buyer": {
            "shop_no": 1,
            "order_id": "20180903-0000243",
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 주문 쓰기권한 (WRITE_ORDER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    order_id
    Required

    주문번호

    주문번호

    name

    주문자명

    email

    이메일

    주문자 이메일

    해당 회원의 이메일

    phone

    주문자 일반 전화

    cellphone

    주문자 휴대 전화

    customer_notification

    고객 알림

    고객에게 알릴 문구

    Orders items

    품주(Items)는 쇼핑몰 고객이 주문할 때 구매한 품목 정보입니다. 쇼핑몰의 품목은 쇼핑몰에서 판매하는 상품의 기본 단위로, 품주에는 구입한 상품의 품목 정보와 더불어, 구매시 선택한 옵션, 주문 수량 등의 정보를 추가로 확인할 수 있습니다.
    품주는 하위 Entity로서 주문(Order) 하위에서만 사용할 수 있습니다.
    품주(Items)의 {#id}는 "item_no"입니다.

    Orders items properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    item_no

    품주 아이디

    품목별 주문번호의 아이디

    order_item_code

    품주코드

    품목별 주문번호의 코드

    variant_code

    품목코드

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

    product_no

    상품번호

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

    product_code

    상품코드

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

    eng_product_name

    영문 상품명

    상품의 영문 이름. 해외 배송 등에 사용 가능함.

    option_id

    상품옵션 아이디

    상품옵션의 아이디

    option_value

    옵션값

    주문한 상품의 옵션값

    option_value_default

    기본옵션값

    기본옵션값

    additional_option_value

    추가입력 옵션 값

    추가입력 옵션 값

    product_name

    상품명

    상품의 이름. 상품명은 상품을 구분하는 가장 기초적인 정보이며 검색 정보가 됨.

    product_name_default

    기본 상품명

    기본 상품명

    product_price

    상품 판매가

    상품의 판매가. 멀티쇼핑몰 운영 시에는 판매가를 쇼핑별 화폐단위로 환산하여 보여줌.

    option_price

    옵션 추가 가격

    옵션별로 해당하는 추가 가격이 있을 경우 그 추가가격.

    additional_discount_price

    상품추가할인액

    상품에 대한 추가 할인금액

    app_item_discount_amount

    앱 상품할인금액

    quantity

    수량

    주문한 상품의 수량

    supplier_product_name

    공급사 상품명

    공급사의 상품명

    supplier_transaction_type

    공급사 거래 유형

    공급사의 거래 유형

    D: 직등록형
    P: 수수료형

    supplier_id

    공급사 아이디

    공급사의 아이디

    supplier_name

    공급사명

    공급사의 이름

    tracking_no

    송장번호

    송장번호

    shipping_code

    배송번호

    배송번호. 품목별 주문번호를 배송준비중으로 처리하면 시스템이 자동으로 부여하는 번호.

    post_express_flag

    우체국 택배연동

    우체국 택배연동 상태

    order_status

    주문상태

    주문상태. 주문 상태별로 각각의 코드가 있음.

    order_status_additional_info

    주문상태 추가정보

    주문상태의 추가정보

    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

    택배사코드

    택배사 코드. 택배사별로 고유한 코드가 존재함.

    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 : 분리되었던 적이 있음
    F : 분리되었던 적이 없음

    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

    배송비 타입

    (개별배송비를 사용할 경우) 상품의 배송비 타입.

    T : 무료
    F : 착불
    D : 차등(금액)
    M : 조건(금액)
    I : 고정
    N : 비례(수량)
    W : 차등(무게)
    C : 차등(수량)
    X : 기본배송

    shipping_fee_type_text

    배송비타입

    배송비 타입 설명

    payment_info_id

    결제정보 아이디

    결제정보 아이디

    original_item_no

    기존 품주 아이디

    기존 품주 아이디

    store_pickup

    매장수령여부

    매장수령 상품 여부

    T : 매장수령
    F : 매장수령 아님

    ordered_date

    timezone

    주문일

    주문일

    shipped_date

    timezone

    배송시작일

    배송 시작일

    delivered_date

    timezone

    배송완료일

    배송 완료일

    cancel_date

    timezone

    주문취소일

    주문 취소일

    return_request_date

    timezone

    반품요청일

    반품 요청일

    return_date

    timezone

    반품완료일

    반품 완료일

    cancel_request_date

    timezone

    취소요청일

    주문취소 요청일

    refund_date

    timezone

    환불완료일

    환불 완료일

    exchange_request_date

    timezone

    교환요청일

    교환 요청일

    exchange_date

    timezone

    교환완료일

    교환 완료일

    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

    해외통관코드

    hs_code

    HS코드

    통관을 위한 hs 코드

    one_plus_n_event

    1+N이벤트 여부

    1개 구매시 N개 증정하는 이벤트 여부

    origin_place

    원산지정보

    상품의 원산지

    gift

    사은품 여부

    상품이 사은품인지 여부

    T : 사은품
    F : 사은품 아님

    List all orders items

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders/{#id}/items'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20170710-0000013/items' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "items": [
            {
                "shop_no": "1",
                "item_no": "1",
                "order_item_code": "20170710-0000013-01",
                "variant_code": "P000000N000A",
                "product_no": "14",
                "product_code": "P000000N",
                "eng_product_name": null,
                "option_id": "000A",
                "option_value": "",
                "option_value_default": "",
                "additional_option_value": "",
                "product_name": "iPhone X",
                "product_name_default": "iPhone X",
                "product_price": "30000.00",
                "option_price": "0.00",
                "additional_discount_price": "0.00",
                "app_item_discount_amount": "0.00",
                "quantity": "1",
                "supplier_product_name": "",
                "supplier_transaction_type": "D",
                "supplier_id": "S0000000",
                "supplier_name": "Apple",
                "tracking_no": "12345678",
                "shipping_code": "D-20170710-0000013-00",
                "post_express_flag": null,
                "order_status": "N40",
                "order_status_additional_info": null,
                "status_code": "N1",
                "status_text": "Shipping Complete",
                "open_market_status": "",
                "bundled_shipping_type": "N",
                "shipping_company_id": "2",
                "shipping_company_name": "DHL",
                "shipping_company_code": "0001",
                "product_bundle": "F",
                "product_bundle_no": "0",
                "product_bundle_name": null,
                "product_bundle_name_default": null,
                "product_bundle_type": "C",
                "was_product_bundle": null,
                "original_bundle_item_no": null,
                "naver_pay_order_id": null,
                "naver_pay_claim_status": "PAYMENT_WAITING",
                "individual_shipping_fee": "0.00",
                "shipping_fee_type": "X",
                "shipping_fee_type_text": "Free",
                "payment_info_id": "0",
                "original_item_no": "",
                "store_pickup": "F",
                "ordered_date": "2017-07-10 15:55:51",
                "shipped_date": "2017-07-10 15:56:52",
                "delivered_date": "2017-07-10 15:57:05",
                "cancel_date": null,
                "return_request_date": null,
                "return_date": null,
                "cancel_request_date": null,
                "refund_date": null,
                "exchange_request_date": null,
                "exchange_date": null,
                "product_material": null,
                "product_material_eng": null,
                "cloth_fabric": null,
                "product_weight": "1.00",
                "volume_size": null,
                "volume_size_weight": null,
                "clearance_category_code": null,
                "clearance_category_code_info": null,
                "clearance_category_code_base": null,
                "hs_code": "",
                "one_plus_n_event": null,
                "origin_place": " ",
                "gift": "F"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 주문 읽기권한 (READ_ORDER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    order_id
    Required

    주문번호

    주문번호

    주문번호

    Orders receivers

    수령자 정보(Receivers)는 주문한 상품을 배송 받을 수령자의 이름, 연락처, 주소 정보 입니다.
    수령자 정보는 하위 Entity로서 주문(Order) 하위에서만 사용할 수 있습니다.

    Orders receivers properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    name

    수령자명

    name_furigana

    수령자명 (발음)

    phone

    전화번호

    cellphone

    수령자 휴대 전화

    virtual_phone_no

    수령자 안심번호

    zipcode

    우편번호

    address1

    기본 주소

    address2

    상세 주소

    name_en

    수령자명 (영문)

    city_en

    수령자 도시 (영문)

    state_en

    수령자 주 (영문)

    street_en

    수령자 주소 (영문)

    country_code

    국가코드

    국가코드

    country_name

    국가명

    국가명

    country_name_en

    국가명 (영문)

    국가명 (영문)

    List all orders receivers

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/orders/{#id}/receivers'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20170710-0000013/receivers' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "receivers": [
            {
                "shop_no": 1,
                "name": "John Doe",
                "name_furigana": "John Doe",
                "phone": "02-0000-0000",
                "cellphone": "010-0000-0000",
                "virtual_phone_no": null,
                "zipcode": "06258",
                "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
                "address2": "Professional Construction Hall",
                "name_en": null,
                "city_en": null,
                "state_en": null,
                "street_en": null,
                "country_code": "",
                "country_name": null,
                "country_name_en": null
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 주문 읽기권한 (READ_ORDER)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    order_id
    Required

    주문번호

    주문번호

    주문번호

    Origin

    원산지(Origin)는 상품이 생산된 지역을 의미합니다. 원산지는 국외 배송 등에 중요한 데이터입니다. 카페24는 다양한 원산지가 코드화 되어있으며, 원산지 조회 API를 통해 원산지 코드 정보를 확인할 수 있습니다.

    Origin properties

    Attribute Description
    origin_place_no

    원산지 번호

    origin_place_name

    원산지 이름

    foreign

    해외 여부

    List all origin

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/origin'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/origin' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "origin": [
            {
                "origin_place_no": "1",
                "origin_place_name": [
                    "Gangwon",
                    "Gangneung-si"
                ],
                "foreign": "F"
            },
            {
                "origin_place_no": "2",
                "origin_place_name": [
                    "Gangwon",
                    "Goseong-gun"
                ],
                "foreign": "F"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 판매분류 읽기권한 (READ_COLLECTION)
    호출건수 제한 30

    요청사양

    Parameter Description
    origin_place_no

    원산지 번호

    origin_place_name

    최대글자수 : [50자]

    원산지 이름

    foreign

    해외 여부

    limit

    최대값: [100]

    조회결과 최대건수

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

    DEFAULT 10

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Products

    Products Entity 관계도
    상품(Products)은 쇼핑몰에서 판매되는 물건이나 서비스를 의미합니다. 상품은 다양한 색 또는 사이즈의 옵션을 통해 품목으로 쪼개질 수 있습니다.

    상품(Products)의 {#id}는 ""product_no""입니다.

    상품은 다음과 같은 Entity를 하위 Entity로 갖고 있습니다.
    품목(Variants)
    상품 메모(Memos)
    SEO(SEO)
    상품 조회 수(Hits)

    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자]

    공급사 상품명

    공급사에서 등록한 상품의 이름. 공급사에서 상품의 구분을 위해 임의로 입력할 수 있으며 상품명에는 영향을 미치지 않는다.

    model_name

    최대글자수 : [100자]

    모델명

    상품의 모델명.

    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

    최대글자수 : [200자]

    상품 검색어

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

    margin_rate

    최소: [-999.99]~최대: [999.99]

    마진률

    상품의 원가에 더하여 판매가 계산을 위한 마진율. Api에서는 해당 값은 참고용으로만 사용된다.

    tax_type

    과세 구분

    해당 상품의 과세 정보.

    해당 상품의 부가세 포함 유형.
    과세상품 = 세금이 부과된 상품.
    면세상품 = 세금이 면제되는 상품. 가공되지 않은 농/수/축산물, 연탄, 도서류, 보험, 여성용품 등의 상품이 이에 해당하며, 과세사업자로 등록해야 함
    영세상품 = 부가세가 0%로 적용되는 수출용 외화 획득 상품

    A : 과세상품
    B : 면세 상품
    C : 영세상품

    tax_amount

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

    과세율

    과세상품인 경우, 해당 상품에 적용되는 부가세율을 명시함.
    부가세는 국가 및 지역에 따라 상이할 수 있음.

    price_content

    최대글자수 : [20자]

    판매가 대체문구

    상품의 가격 대신 표시되는 문구. 품절이나 상품이 일시적으로 판매 불가할 때 사용.

    buy_limit_type

    구매제한

    해당 상품을 구매할 수 있는 회원 정보 표시.

    N : 회원만 구매하며
    구매버튼 감추기
    M : 회원만 구매하며
    구매버튼 보이기
    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"으로 표시된다.

    mileage_amount

    적립금 설정 정보

    상품 주문시 받을 수 있는 적립금 금액. 설정에 따라 적립금을 결제수단에 상관 없이 공통적으로 받도록 설정하거나 결제수단별로 받도록 설정할 수 있다.

    except_member_mileage

    회원등급 추가 적립 제외

    회원등급 설정 화면에서 상품 구매시 적립금을 설정한 경우, 해당 설정이 체크되어있는 상품은 적립금 지급 제외됨

    adult_certification

    성인인증

    성인인증이 필요한 상품인지 여부. 성인인증이 필요한 상품인 구매를 위해서는 본인인증을 거쳐야함.

    detail_image

    상세이미지

    상품 상세 화면에 표시되는 상품 이미지.

    list_image

    목록이미지

    상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.

    tiny_image

    작은목록이미지

    최근 본 상품 영역에 표시되는 상품의 목록 이미지.

    small_image

    축소이미지

    상품 상세 화면 하단에 표시되는 상품 목록 이미지.

    has_option

    옵션 사용여부

    해당 상품이 옵션을 갖고 있는지에 대한 여부. 옵션을 갖고 있는 상품은 사이즈나 색상과 같은 다양한 선택지를 제공한다.

    T : 옵션사용함
    F : 옵션 사용안함

    option_type

    옵션 구성방식

    옵션을 사용할 경우, 옵션의 유형 표시

    ● 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨
    ● 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음
    ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음.
    ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨.

    C : 조합 일체선택형
    S : 조합 분리선택형
    E : 상품 연동형
    F : 독립 선택형

    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)"일 경우 원산지로 입력 가능한 정보.

    icon_show_period

    아이콘 노출 기간

    상품에 설정한 아이콘이 노출되는 기간.

    icon

    배열 최대사이즈: [5]

    아이콘

    상품에 표시되는 아이콘. 상품 판매를 강조하기 위한 목적으로 사용이 가능함.

    hscode

    HS코드

    해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함.

    ※ HS코드 : 세계무역기구(WTO) 및 세계관세기구(WCO)가 무역통계 및 관세분류의 목적상 수출입 상품을 숫자 코드로 분류화 한 것으로, 수입 시 세금부과와 수출품의 통제 및 통계를 위한 분류법

    product_weight

    상품 중량

    상품의 전체 중량(kg). 배송을 위해 상품 자체의 무게와 박스 무게, 포장무게를 모두 포함한 중량 기재가 필요하다.

    product_material

    상품소재

    상품의 소재. 복합 소재일 경우 상품의 소재와 함유랑을 함께 입력해야함. (예 : 면 80%, 레이온 20%)

    created_date

    timezone

    생성일

    상품이 생성된 일시.

    updated_date

    timezone

    수정일

    상품이 수정된 일시.

    english_product_material

    영문 상품 소재

    상품의 소재의 영어 표기. 해외 배송사를 이용할 경우 의류의 소재를 통관시 요구하는 경우가 있음.

    cloth_fabric

    옷감

    상품이 의류인 경우, 옷감. 일본 택배사를 이용할 경우, 택배사에 따라 의류 통관시 옷감 정보를 입력 받는 경우가 있음.

    woven : 직물(woven)
    knit : 편물(knit)

    list_icon

    추천 / 품절 / 신상품 아이콘 노출 여부

    추천, 품절, 신상품 아이콘을 목록에서 표시하는지 여부

    ※ 품절 아이콘

    ● 상품이 품절 상태임을 알려주는 아이콘
    ● 재고관리 및 품절 기능을 사용하는 상품에 대해 재고가 없을 경우 표시

    ※ 추천, 신상품 아이콘

    ● 상품분류나 메인화면의 추천상품, 신상품 영역에 진열된 상품인 경우, 설정에 따라 해당 아이콘을 표시함

    ※ 아이콘 노출 여부 설정위치 : [상점관리> 운영관리> 운영방식 설정> (탭)상품 관련 설정> 상품 아이콘 설정]

    select_one_by_option

    옵션별로 한 개씩 선택 (독립형 옵션)

    독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함.

    T : 사용함
    F : 사용안함

    approve_status

    승인요청 결과

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

    classification_code

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

    자체분류 코드

    자체분류를 등록하면 자동으로 생성되는 코드로 상품에 특정 자체분류를 지정할 때 사용.

    미입력시 기본자체분류(C000000A) 사용

    sold_out

    품절여부

    T : 품절
    F : 품절아님

    additional_price

    판매가 추가금액

    discountprice

    상품 할인판매가 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    decorationimages

    꾸미기 이미지 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    variants

    품목 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    상세 조회시에만 확인 가능하다.

    memos

    메모 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    상세 조회시에만 확인 가능하다.

    hits

    상품 조회수 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    상세 조회시에만 확인 가능하다.

    seo

    상품 Seo Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    상세 조회시에만 확인 가능하다.

    category

    분류 번호

    해당 상품이 진열되어있는 상품 분류.

    상세 조회시에만 확인 가능하다.

    description

    상품상세설명

    상품에 보다 상세한 정보가 포함되어있는 설명. HTML을 사용하여 입력이 가능하다.

    상세 조회시에만 확인 가능하다.

    mobile_description

    모바일 상품 상세설명

    입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.

    상세 조회시에만 확인 가능하다.

    additional_image

    배열 최대사이즈: [20]

    추가이미지

    상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다.

    특정 상품 상세 조회 API에서만 확인 가능하다.

    상세 조회시에만 확인 가능하다.

    payment_info

    상품결제안내

    상품의 결제 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.

    상세 조회시에만 확인 가능하다.

    shipping_info

    상품배송안내

    상품의 배송 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.

    상세 조회시에만 확인 가능하다.

    exchange_info

    교환/반품안내

    상품의 교환/반품 방법에 대한 안내 문구. HTML을 사용하여 입력이 가능하다.

    상세 조회시에만 확인 가능하다.

    service_info

    서비스문의/안내

    제품의 사후 고객 서비스 방법 대한 안내 문구. HTML을 사용하여 입력이 가능하다.

    상세 조회시에만 확인 가능하다.

    product_tax_type_text

    부가세 표시 문구

    상품관리 > 상품표시관리 > 상품정보표시 설정 > 판매가 부가세 표시 문구에서 설정한 문구 표시

    상세 조회시에만 확인 가능하다.

    set_product_type

    세트상품 타입

    상세 조회시에만 확인 가능하다.

    C : 일반세트
    S : 분리세트

    country_hscode

    국가별 HS 코드

    해외 배송시 관세 부과를 위해 사용하는 HS코드. 국제 배송시 통관을 위해 반드시 정확한 번호를 입력해야 함.

    국가별로 HS 코드의 표준이 다르기 때문에 해당 국가에 맞는 코드 입력이 필요함.

    상세 조회시에만 확인 가능하다.

    simple_description

    상품 간략 설명

    상품에 대한 간략한 정보. 상품 진열 화면에서 노출 가능한 설명. HTML을 사용하여 입력이 가능하다.
    상품관리 > 상품표시관리 > 상품정보표시 설정에서 노출되도록 설정 가능하다.

    상세 조회시에만 확인 가능하다.

    tags

    상품 태그 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    상세 조회시에만 확인 가능하다.

    options

    상품 옵션 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    상세 조회시에만 확인 가능하다.

    shipping_fee_by_product

    개별배송여부

    상품에 배송비를 개별적으로 부과할 것인지 공통 배송비를 부과할 것인지에 대한 설정.

    개별 배송비를 사용하지 않을 경우 공통 배송비를 사용함.

    상세 조회시에만 확인 가능하다.

    shipping_method

    배송방법

    (개별배송비를 사용할 경우) 배송 수단 및 방법

    상세 조회시에만 확인 가능하다.

    01 : 택배
    02 : 빠른등기
    03 : 일반등기
    04 : 직접배송
    05 : 퀵배송
    06 : 기타
    07 : 화물배송
    08 : 매장직접수령
    09 : 배송필요 없음

    prepaid_shipping_fee

    배송비 선결제 설정

    상세 조회시에만 확인 가능하다.

    C : 착불
    P : 선결제
    B : 선결제/착불

    shipping_period

    배송기간

    (개별배송비를 사용할 경우) 상품 배송시 평균적으로 소요되는 배송 기간.

    상세 조회시에만 확인 가능하다.

    shipping_scope

    배송정보

    국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. 상점관리 > 배송관리 > 배송/반품 설정에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가.

    상세 조회시에만 확인 가능하다.

    A : 국내배송
    C : 해외배송
    B : 국내/해외배송

    shipping_area

    최대글자수 : [255자]

    배송지역

    (개별배송비를 사용할 경우) 상품을 배송할 수 있는 지역.

    상세 조회시에만 확인 가능하다.

    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_eng

    해외통관용 상품구분 영문명

    해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 국문명 입력시 입력한 구분명이 자동으로 번역된 항목.

    번역된 영문명이 해외송장 상품명에 포함되어 전송됨.

    상세 조회시에만 확인 가능하다.

    clearance_category_kor

    해외통관용 상품구분 국문명

    해외 통관시 통관용 상품 구분 정보로 사용하는 정보. 자동으로 영문으로 번역되어 해외송장 상품명 정보에 포함하여 전송.

    상세 조회시에만 확인 가능하다.

    clearance_category_code

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

    해외통관코드

    상세 조회시에만 확인 가능하다.

    origin_place_code

    원산지 코드

    상품의 원산지 코드.

    상세 조회시에만 확인 가능하다.

    additional_information

    추가항목

    상품관리 > 상품표시관리 > 상품정보표시 설정에서 추가한 추가항목.

    기본적인 상품 정보 외에 추가로 표시항 항목이 있을 때 추가하여 사용함.

    상세 조회시에만 확인 가능하다.

    image_upload_type

    이미지 업로드 타입

    이미지 업로드시 이미지 업로드 타입.
    "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드
    "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드

    ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음

    상세 조회시에만 확인 가능하다.

    A : 대표이미지등록
    B : 개별이미지등록
    C : 웹FTP 등록

    main

    메인진열

    상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.

    상세 조회시에만 확인 가능하다.

    relational_product

    관련상품

    해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.

    상세 조회시에만 확인 가능하다.

    List all products

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products' \
      -H 'Authorization: Bearer {access_token}' \
      -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",
                "supply_product_name": "iphone A1865 fdd lte",
                "model_name": "A1865",
                "price": "1000.00",
                "retail_price": "0.00",
                "supply_price": "9000.00",
                "display": "T",
                "selling": "F",
                "product_condition": "U",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "margin_rate": "10.00",
                "tax_type": "A",
                "tax_amount": 10,
                "price_content": null,
                "buy_limit_type": "F",
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "except_member_mileage": "F",
                "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",
                "supplier_code": "S0000000",
                "made_date": "",
                "release_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"
                ],
                "hscode": "4303101990",
                "product_weight": 1,
                "product_material": "",
                "created_date": "2018-01-18T11:19:27+09:00",
                "updated_date": "2018-01-19T11:19:27+09:00",
                "english_product_material": null,
                "cloth_fabric": null,
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "",
                "classification_code": "C000000A",
                "sold_out": "F",
                "additional_price": "0.00"
            },
            {
                "shop_no": 1,
                "product_no": 23,
                "product_code": "P000000W",
                "custom_product_code": "",
                "product_name": "iPhone X",
                "eng_product_name": "iPhone Ten",
                "supply_product_name": "iphone A1865 fdd lte",
                "model_name": "A1865",
                "price": 1000,
                "retail_price": 0,
                "supply_price": 0,
                "display": "T",
                "selling": "F",
                "product_condition": "U",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "margin_rate": "10.00",
                "tax_type": "A",
                "tax_amount": 10,
                "price_content": null,
                "buy_limit_type": "F",
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "except_member_mileage": "F",
                "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",
                "supplier_code": "S0000000",
                "made_date": "",
                "release_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"
                ],
                "hscode": "4303101990",
                "product_weight": 1,
                "product_material": "",
                "created_date": "2018-01-18T11:19:27+09:00",
                "updated_date": "2018-01-19T11:19:27+09:00",
                "english_product_material": null,
                "cloth_fabric": null,
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "C",
                "classification_code": "C000000A",
                "sold_out": "F",
                "additional_price": "0.00"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    discountprice
    embed

    상품 할인판매가 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    decorationimages
    embed

    꾸미기 이미지 Entity


    조회시 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

    자체상품 코드

    검색어를 자체상품코드에 포함하고 있는 상품 검색(대소문자 구분 필요)

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

    price_min

    상품 판매가 검색 최소값

    판매가가 해당 범위 이상인 상품 검색

    price_max

    상품 판매가 검색 최대값

    판매가가 해당 범위 이하인 상품 검색

    retail_price_min

    상품 소비자가 검색 최소값

    소비자가가 해당 범위 이상인 상품 검색

    retail_price_max

    상품 소비자가 검색 최대값

    소비자가가 해당 범위 이하인 상품 검색

    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 : 사용함
    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

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

    해당 상품번호 이후 검색

    특정 상품번호 이후의 상품들을 검색. 해당 검색조건 사용시 offset과 관계 없이 모든 상품을 검색할 수 있다.

    ※ 해당 검색 조건 사용시 다음 파라메터로는 사용할 수 없다.

    product_no
    sort
    order
    offset

    sort

    정렬 순서 값

    created_date : 등록일
    updated_date : 수정일
    product_name : 상품명

    order

    정렬 순서

    asc : 순차정렬
    desc : 역순 정렬

    offset

    최대값: [5000]

    조회결과 시작위치

    조회결과 시작위치

    limit

    최대값: [100]

    조회결과 최대건수

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

    DEFAULT 10

    Count all products

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (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

    상품 소비자가 검색 최소값

    소비자가가 해당 범위 이상인 상품 검색

    retail_price_max

    상품 소비자가 검색 최대값

    소비자가가 해당 범위 이하인 상품 검색

    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 : 사용함
    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

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

    해당 상품번호 이후 검색

    특정 상품번호 이후의 상품들을 검색. 해당 검색조건 사용시 offset과 관계 없이 모든 상품을 검색할 수 있다.

    ※ 해당 검색 조건 사용시 다음 파라메터로는 사용할 수 없다.

    product_no
    sort
    order
    offset

    Get a product

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "variants": null,
            "memos": null,
            "hits": null,
            "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",
            "supply_product_name": "iphone A1865 fdd lte",
            "model_name": "A1865",
            "price": "1000.00",
            "retail_price": "0.00",
            "supply_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.",
            "meta_title": "",
            "meta_author": "",
            "meta_description": "",
            "meta_keywords": "",
            "meta_alt": "",
            "search_engine_exposure": "T",
            "product_tax_type_text": null,
            "set_product_type": null,
            "country_hscode": {
                "JPN": "430310011",
                "CHN": "43031020"
            },
            "selling": "F",
            "product_condition": "U",
            "product_used_month": 2,
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "product_tag": "edu,test,sample",
            "tags": {
                "tag": [
                    "edu",
                    "test",
                    "sample"
                ]
            },
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "price_content": null,
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "mileage_amount": null,
            "except_member_mileage": "F",
            "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",
            "supplier_code": "S000000A",
            "made_date": "",
            "release_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,
            "hscode": "4303101990",
            "product_weight": 1,
            "product_material": "",
            "shipping_fee_by_product": "T",
            "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"
                }
            ],
            "created_date": "2018-01-18T11:19:27+09:00",
            "updated_date": "2018-01-19T11:19:27+09:00",
            "english_product_material": null,
            "clearance_category_eng": "Necklaces",
            "clearance_category_kor": "주얼리 > 목걸이",
            "clearance_category_code": "ACAB0000",
            "cloth_fabric": null,
            "list_icon": {
                "soldout_icon": true,
                "recommend_icon": true,
                "new_icon": true
            },
            "additional_information": [
                {
                    "key": "custom_option1",
                    "name": "gift option",
                    "value": "Yes"
                }
            ],
            "image_upload_type": "A",
            "classification_code": "C000000A",
            "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",
            "additional_price": "0.00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

    조회하고자 하는 상품의 번호

    variants
    embed

    품목 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    memos
    embed

    메모 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    hits
    embed

    상품 조회수 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    seo
    embed

    상품 Seo Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    tags
    embed

    상품 태그 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    options
    embed

    상품 옵션 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    discountprice
    embed

    상품 할인판매가 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    decorationimages
    embed

    꾸미기 이미지 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    Create a product

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "add_category_no": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": 10000,
            "retail_price": 0,
            "supply_price": 9000,
            "has_option": "T",
            "option": [
                {
                    "name": "Color",
                    "value": [
                        "Red",
                        "Blue",
                        "Green"
                    ]
                },
                {
                    "name": "Size",
                    "value": [
                        "X",
                        "L",
                        "M",
                        "S"
                    ]
                }
            ],
            "image_upload_type": "A",
            "detail_image": "\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "manufacturer_code": "M0000000",
            "supplier_code": "S0000000",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "summary_description": "This is Product Summary.",
            "simple_description": "This is Product Description.",
            "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.",
            "hscode": "4303101990",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "shipping_scope": "A",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "clearance_category_code": "ACAB0000",
            "shipping_rates": [
                {
                    "shipping_rates_min": 2000,
                    "shipping_rates_max": 4000,
                    "shipping_fee": 5000
                },
                {
                    "shipping_rates_min": 4000,
                    "shipping_rates_max": 6000,
                    "shipping_fee": 2500
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "prepaid_shipping_fee": "P",
            "origin_classification": "F",
            "origin_place_no": 1798,
            "additional_image": [
                "201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                "201810\/e1ab68969d69287a828438c7684b14c4.jpg"
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": 28,
            "category": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "product_code": "P00000BB",
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": "10000.00",
            "retail_price": "0.00",
            "supply_price": "9000.00",
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "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.",
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "has_option": "T",
            "manufacturer_code": "M0000000",
            "supplier_code": "S000000A",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "hscode": "4303101990",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_scope": "A",
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shipping_rates_min": "2000.00",
                    "shipping_rates_max": "4000.00",
                    "shipping_fee": "5000.00"
                },
                {
                    "shipping_rates_min": "4000.00",
                    "shipping_rates_max": "6000.00",
                    "shipping_fee": "2500.00"
                }
            ],
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "image_upload_type": "A",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "origin_classification": "F",
            "origin_place_no": 1798,
            "created_date": "2018-05-29T14:23:51+09:00",
            "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"
                }
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    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

    추가 분류 번호

    분류 번호를 사용하여 진열을 원하는 카테고리에 상품 등록

    custom_product_code

    최대글자수 : [40자]

    자체상품 코드

    사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.

    product_name
    Required

    최대글자수 : [250자]

    상품명

    eng_product_name

    최대글자수 : [250자]

    영문 상품명

    model_name

    최대글자수 : [100자]

    모델명

    price
    Required

    최대값: [2147483647]

    상품 판매가

    retail_price

    최대값: [2147483647]

    상품 소비자가

    supply_price
    Required

    최대값: [2147483647]

    상품 공급가

    상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.

    has_option

    옵션 사용여부

    T : 옵션사용함
    F : 옵션 사용안함

    DEFAULT F

    option

    옵션

    수정할 옵션명과 옵션값 입력

    manufacturer_code

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

    제조사 코드

    DEFAULT M0000000

    supplier_code

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

    공급사 코드

    DEFAULT S0000000

    expiration_date

    배열 최대사이즈: [2]

    유효기간

    description

    상품상세설명

    mobile_description

    모바일 상품 상세설명

    입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.

    summary_description

    최대글자수 : [255자]

    상품요약설명

    simple_description

    상품 간략 설명

    product_tag

    최대글자수 : [200자]

    상품 검색어

    payment_info

    상품결제안내

    shipping_info

    상품배송안내

    exchange_info

    교환/반품안내

    service_info

    서비스문의/안내

    icon

    배열 최대사이즈: [5]

    아이콘

    hscode

    최대글자수 : [20자]

    HS코드

    배송정보(shipping_scope)가 B(국내/해외) 또는 C(해외배송)일 경우 필수 입력

    shipping_scope

    배송정보

    국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. 상점관리 > 배송관리 > 배송/반품 설정에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가.

    ※ 쇼핑몰이 EC Global 쇼핑몰일 경우 "C"를 필수로 입력해야한다.

    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자]

    배송지역

    DEFAULT 전국지역

    shipping_period

    배열 최대사이즈: [2]

    배송기간

    shipping_fee_type

    배송비 타입

    개별배송비를 사용할 경우 상품의 배송비 타입.

    T : 배송비 무료
    R : 고정배송비 사용
    M : 구매 금액에 따른 부과
    D : 구매 금액별 차등 배송료 사용
    W : 상품 무게별 차등 배송료 사용
    C : 상품 수량별 차등 배송료 사용
    N : 상품 수량에 비례하여 배송료 부과

    DEFAULT T

    shipping_rates

    배송비 금액

    개별배송비를 사용할 경우 상품의 개별 배송비.

    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

    배송비 선결제 설정

    C : 착불
    P : 선결제
    B : 선결제/착불

    DEFAULT B

    clearance_category_code

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

    해외통관코드

    배송정보(shipping_scope)가 B(국내/해외) 또는 C(해외배송)일 경우 필수 입력

    detail_image

    상세이미지

    list_image

    목록이미지

    tiny_image

    작은목록이미지

    small_image

    축소이미지

    image_upload_type

    이미지 업로드 타입

    이미지 업로드시 이미지 업로드 타입.
    "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드
    "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드

    ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음

    A : 대표이미지등록
    B : 개별이미지등록
    C : 웹FTP 등록

    DEFAULT A

    additional_information

    추가항목

    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을 입력

    origin_classification

    원산지 국내/국외/기타

    F : 국내
    T : 국외
    E : 기타

    DEFAULT F

    origin_place_no

    원산지 번호

    원산지 번호를 List all Origin API를 통해 원산지를 조회하여 입력
    origin_classification이 F(국내)인 경우, 해외 여부(foreign)가 "F"인 원산지만 입력 가능함.
    origin_classification이 T(해외)인 경우, 해외 여부(foreign)가 "T"인 원산지만 입력 가능함.

    DEFAULT 1798

    origin_place_value

    최대글자수 : [30자]

    원산지기타정보

    원산지가 "기타(1800)"일 경우 원산지로 입력 가능한 정보.

    main

    메인진열

    상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.

    relational_product

    관련상품

    해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.

    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 : 영세상품

    DEFAULT A

    tax_amount

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

    과세율

    과세상품인 경우, 해당 상품에 적용되는 부가세율을 명시함.
    부가세는 국가 및 지역에 따라 상이할 수 있음.

    additional_image

    추가이미지

    상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다.

    추가이미지는 최대 20개까지 등록 가능하다.

    Update a product

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "add_category_no": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "delete_category_no": [
                27
            ],
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": 10000,
            "retail_price": 0,
            "supply_price": 9000,
            "has_option": "F",
            "image_upload_type": "A",
            "detail_image": "\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "manufacturer_code": "M0000000",
            "supplier_code": "S0000000",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "summary_description": "This is Product Summary.",
            "simple_description": "This is Product Description.",
            "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.",
            "hscode": "4303101990",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "shipping_scope": "A",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shipping_rates_min": 2000,
                    "shipping_rates_max": 4000,
                    "shipping_fee": 5000
                },
                {
                    "shipping_rates_min": 4000,
                    "shipping_rates_max": 6000,
                    "shipping_fee": 2500
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "origin_classification": "F",
            "origin_place_no": 1798,
            "additional_image": [
                "201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                "201810\/e1ab68969d69287a828438c7684b14c4.jpg"
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": 7,
            "category": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "product_code": "P000000R",
            "custom_product_code": "",
            "product_name": "edu center product",
            "eng_product_name": "education center product",
            "model_name": "sample model",
            "price": "10000.00",
            "retail_price": "0.00",
            "supply_price": "9000.00",
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "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.",
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "has_option": "F",
            "manufacturer_code": "M0000000",
            "supplier_code": "S000000A",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "hscode": "4303101990",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_scope": "A",
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shipping_rates_min": "2000.00",
                    "shipping_rates_max": "4000.00",
                    "shipping_fee": "5000.00"
                },
                {
                    "shipping_rates_min": "4000.00",
                    "shipping_rates_max": "6000.00",
                    "shipping_fee": "2500.00"
                }
            ],
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "image_upload_type": "A",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "origin_classification": "F",
            "origin_place_no": 1798,
            "updated_date": "2018-05-29T14:23:51+09:00",
            "translated_additional_description": "This is a translated additional description of product.",
            "translated": "T",
            "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"
                }
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    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

    추가 분류 번호

    상품분류 번호를 입력하여 해당 상품에 특정 상품분류를 추가 등록

    delete_category_no

    삭제 분류 번호

    상품분류 번호를 입력하여 해당 상품에 특정 상품분류 삭제

    custom_product_code

    최대글자수 : [40자]

    자체상품 코드

    사용자가 상품에 부여 가능한 코드. 재고 관리등의 이유로 자체적으로 상품을 관리 하고 있는 경우 사용함.

    product_name

    최대글자수 : [250자]

    상품명

    eng_product_name

    최대글자수 : [250자]

    영문 상품명

    model_name

    최대글자수 : [100자]

    모델명

    price

    최대값: [2147483647]

    상품 판매가

    retail_price

    최대값: [2147483647]

    상품 소비자가

    supply_price

    최대값: [2147483647]

    상품 공급가

    상품의 원가. 공급가에 마진율을 더하여 판매가를 계산할 수 있음. API에서는 공급가는 참조 목적으로만 사용한다.

    has_option

    옵션 사용여부

    F : 옵션 사용안함

    manufacturer_code

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

    제조사 코드

    supplier_code

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

    공급사 코드

    expiration_date

    배열 최대사이즈: [2]

    유효기간

    description

    상품상세설명

    mobile_description

    모바일 상품 상세설명

    입력시 모바일 쇼핑몰에서 상품상세설명 대신 모바일 상품 상세 설명을 대신 표시함.

    summary_description

    최대글자수 : [255자]

    상품요약설명

    simple_description

    상품 간략 설명

    product_tag

    최대글자수 : [200자]

    상품 검색어

    payment_info

    상품결제안내

    shipping_info

    상품배송안내

    exchange_info

    교환/반품안내

    service_info

    서비스문의/안내

    icon

    배열 최대사이즈: [5]

    아이콘

    hscode

    최대글자수 : [20자]

    HS코드

    배송정보(shipping_scope)가 B(국내/해외) 또는 C(해외배송)일 경우 필수 입력

    shipping_scope

    배송정보

    국내에만 배송이 가능한 상품인지 해외에도 배송이 가능한 상품인지 표시. 상점관리 > 배송관리 > 배송/반품 설정에서 상품별 개별 배송료 설정이 사용안함인 경우 설정 불가.

    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

    배열 최대사이즈: [2]

    배송기간

    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 : 배송비

    prepaid_shipping_fee

    배송비 선결제 설정

    C : 착불
    P : 선결제
    B : 선결제/착불

    clearance_category_code

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

    해외통관코드

    배송정보(shipping_scope)가 B(국내/해외) 또는 C(해외배송)일 경우 필수 입력

    detail_image

    상세이미지

    list_image

    목록이미지

    tiny_image

    작은목록이미지

    small_image

    축소이미지

    image_upload_type

    이미지 업로드 타입

    이미지 업로드시 이미지 업로드 타입.
    "대표이미지 등록"시 상세이미지를 리사이징하여 목록이미지, 작은목록이미지, 축소이미지에 업로드
    "개별이미지 등록"시 상세이미지, 목록이미지, 작은목록이미지, 축소이미지를 각각 따로 업로드

    ※ EC Global은 FTP를 지원하지 않으므로 C는 사용할 수 없음

    A : 대표이미지등록
    B : 개별이미지등록
    C : 웹FTP 등록

    additional_information

    추가항목

    buy_unit_type

    구매단위 타입

    해당 상품의 구매 단위를 1개 이상으로 설정한 경우 해당 구매 단위를 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정

    P : 상품 기준
    O : 품목 기준

    buy_unit

    최대값: [2147483647]

    구매단위

    order_quantity_limit_type

    주문수량 제한 기준

    해당 상품의 주문 수량 제한시 제한 기준을 품목 단위로 할 것인지, 상품 단위로 할 것인지에 대한 설정

    P : 상품 기준
    O : 품목 기준

    minimum_quantity

    최대값: [2147483647]

    최소 주문수량

    주문 가능한 최소한의 주문 수량. 주문 수량 미만으로 구매 할 수 없음.

    최소 주문수량 수정시 최대주문수량을 같이 수정해야 한다.

    maximum_quantity

    최대값: [2147483647]

    최대 주문수량

    주문 가능한 최대한의 주문 수량. 주문 수량을 초과하여 구매 할 수 없음.

    최대 주문수량을 "제한없음"으로 입력하려면 0을 입력

    최소주문수량 수정시 최대주문수량을 같이 수정해야한다.

    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)"일 경우 원산지로 입력 가능한 정보.

    main

    메인진열

    상품을 "추천상품", "신상품"과 같은 메인진열에 진열할 경우, 메인 진열 번호를 표시한다.

    relational_product

    관련상품

    해당 상품과 비슷한 상품 혹은 대체 가능한 상품. 관련 상품 등록시 해당 상품의 상세페이지 하단에 노출된다.

    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_amount

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

    과세율

    과세상품인 경우, 해당 상품에 적용되는 부가세율을 명시함.
    부가세는 국가 및 지역에 따라 상이할 수 있음.

    additional_image

    추가이미지

    상품 상세 화면 하단에 표시되는 상품의 추가 이미지. 축소 이미지와 비슷한 위치에 표시되며 PC 쇼핑몰에서는 마우스 오버시, 모바일 쇼핑몰에서는 이미지 스와이프(Swipe)시 추가 이미지를 확인할 수 있다.

    추가이미지는 최대 20개까지 등록 가능하다.

    Delete a product

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/28' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "product": {
            "product_no": 28
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Products approve

    공급사의 상품 승인 기능을 사용중인 몰에서만 사용할 수 있는 API입니다.

    Products approve properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    status

    상태

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

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

    product_no
    Required

    상품번호

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

    Create a products approve

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/approve'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/approve' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "user_id": "supplytwo"
        }
    }'
    

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "N",
            "product_no": "7"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

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

    user_id
    Required

    공급사 운영자 아이디

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

    Update a products approve

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/approve'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/approve' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "user_id": "supplytwo",
            "status": "C"
        }
    }'
    

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "C",
            "product_no": "7"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    user_id
    Required

    공급사 운영자 아이디

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

    status
    Required

    상태

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

    C : 승인완료 상태값
    R : 승인거절 상태값
    I : 검수진행중 상태값

    Get products approve status

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/approve'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/approve' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "C",
            "product_no": "7"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    Products cart

    상품 장바구니는 상품별로 고객이 장바구니에 얼마나 많은 상품을 담았는지 확인할 수 있는 정보입니다. 상품 장바구니 API로 상품이 얼마나 고객의 장바구니에 많이 담겨있는지 확인 가능합니다.

    Products cart properties

    Count all products cart

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/cart/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/11/cart/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 7
    }
    

    기본스펙

    Property Description
    SCOPE 개인화정보 읽기권한 (READ_PERSONAL)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Products decorationimages

    Products decorationimages properties

    Attribute Description
    code

    꾸미기 이미지 코드

    path

    꾸미기 이미지 URL

    use_show_date

    표시기간 사용 여부

    T : 사용함
    F : 사용안함

    show_start_date

    timezone

    표시기간 시작 일자

    show_end_date

    timezone

    표시기간 종료 일자

    image_list

    꾸미기 이미지 리스트

    List all decoration images

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/decorationimages'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/decorationimages' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "decorationimages": [
            {
                "code": "icon_01_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_01_01.gif"
            },
            {
                "code": "icon_02_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_02_01.gif"
            },
            {
                "code": "icon_05_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_05_01.gif"
            },
            {
                "code": "custom_1",
                "path": "\/web\/upload\/\/custom_1.gif"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    List all products decoration images

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages' \
      -H 'Authorization: Bearer {access_token}' \
      -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": "\/web\/upload\/image_custom_415421761806290.gif",
                    "image_vertical_position": "L",
                    "image_horizontal_position": "T"
                },
                {
                    "code": "image_custom_3",
                    "path": "\/web\/upload\/image_custom_615421761805558.gif",
                    "image_vertical_position": "C",
                    "image_horizontal_position": "B"
                }
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    Add decoration images to a products

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "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_3",
                    "image_vertical_position": "C",
                    "image_horizontal_position": "B"
                },
                {
                    "code": "image_custom_4",
                    "image_vertical_position": "L",
                    "image_horizontal_position": "T"
                }
            ]
        }
    }'
    

    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": "\/web\/upload\/image_custom_415421761806290.gif",
                    "image_vertical_position": "L",
                    "image_horizontal_position": "T"
                },
                {
                    "code": "image_custom_3",
                    "path": "\/web\/upload\/image_custom_615421761805558.gif",
                    "image_vertical_position": "C",
                    "image_horizontal_position": "B"
                }
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

    use_show_date

    표시기간 사용 여부

    T : 사용함
    F : 사용안함

    show_start_date

    날짜
    timezone

    표시기간 시작 일자

    show_end_date

    날짜
    timezone

    표시기간 종료 일자

    image_list
    Required

    꾸미기 이미지 리스트

    Update a products decorationimage

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "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_3",
                    "image_vertical_position": "C",
                    "image_horizontal_position": "B"
                },
                {
                    "code": "image_custom_4",
                    "image_vertical_position": "L",
                    "image_horizontal_position": "T"
                }
            ]
        }
    }'
    

    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": "\/web\/upload\/image_custom_415421761806290.gif",
                    "image_vertical_position": "L",
                    "image_horizontal_position": "T"
                },
                {
                    "code": "image_custom_3",
                    "path": "\/web\/upload\/image_custom_615421761805558.gif",
                    "image_vertical_position": "C",
                    "image_horizontal_position": "B"
                }
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    use_show_date

    표시기간 사용 여부

    T : 사용함
    F : 사용안함

    show_start_date

    날짜
    timezone

    표시기간 시작 일자

    show_end_date

    날짜
    timezone

    표시기간 종료 일자

    image_list
    Required

    꾸미기 이미지 리스트

    Delete a decoration images to a product

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/decorationimages/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/decorationimages/icon_02_01' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "decorationimage": {
            "code": "icon_02_01"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    code
    Required

    꾸미기 이미지 코드

    product_no
    Required

    상품번호

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

    Products discountprice

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC 할인 판매가

    mobile_discount_price

    모바일 할인 판매가

    List all products discountprice

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/discountprice'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/discountprice' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "discountprice": {
            "pc_discount_price": "7000.00",
            "mobile_discount_price": "6000.00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    Products hits

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

    Products hits properties

    Count all products hits

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/hits/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/hits/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Products icons

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

    Products icons properties

    Attribute Description
    code

    아이콘 코드

    path

    아이콘 URL

    List all products icons

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/icons'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/icons' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "icons": [
            {
                "code": "icon_01_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_01_01.gif"
            },
            {
                "code": "icon_02_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_02_01.gif"
            },
            {
                "code": "icon_05_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_05_01.gif"
            },
            {
                "code": "custom_1",
                "path": "\/web\/upload\/\/custom_1.gif"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    Products images

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

    Products images properties

    Attribute Description
    path

    상세이미지

    상세이미지

    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

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

    detail_image

    상세이미지

    상품 상세 화면에 표시되는 상품 이미지.

    list_image

    목록이미지

    상품 분류 화면, 메인 화면, 상품 검색 화면에 표시되는 상품의 목록 이미지.

    tiny_image

    작은목록이미지

    상품 상세 화면 하단에 표시되는 상품 목록 이미지.

    small_image

    축소이미지

    최근 본 상품 영역에 표시되는 상품의 목록 이미지.

    Upload a image

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/images'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/images' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "image": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAXSURBVChTY1BQdvhPDB5ViBdTW6HDfwA+dpbJG+7kLwAAAABJRU5ErkJggg==\n"
        }
    }'
    

    Response example:

    {
        "image": {
            "path": "http:\/\/{domain}\/web\/upload\/NNEditor\/20180130\/12ecf27747401c8502ddd6b2e79e1e64.png"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    image
    Required

    상세이미지

    상품 상세 화면에 표시되는 상품 이미지.

    Upload product images

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/images'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/images' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "image_upload_type": "B",
            "detail_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "list_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "tiny_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "small_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII="
        }
    }'
    

    Response example:

    {
        "image": {
            "shop_no": 1,
            "product_no": 20,
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "list_image": "http:\/\/{domain}\/web\/product\/medium\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "small_image": "http:\/\/{domain}\/web\/product\/small\/201801\/995feab7d359875e073ae82b48192a7b.jpeg"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    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 : 개별이미지등록

    Delete a products image

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/images'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/images' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "image": {
            "product_no": 20
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Products memos

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

    Products memos properties

    Attribute Description
    memo_no

    메모 번호

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

    author_id

    최대글자수 : [20자]

    작성자 아이디

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

    created_date

    timezone

    생성일

    메모를 작성한 시간.

    memo

    메모

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

    List all products memos

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/memos'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memos": [
            {
                "memo_no": 4,
                "author_id": "subadmin1",
                "created_date": "2018-01-18T11:19:27+09:00",
                "memo": "This is a sample memo."
            },
            {
                "memo_no": 3,
                "author_id": "subadmin2",
                "created_date": "2018-01-18T11:19:27+09:00",
                "memo": "This is a sample memo."
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    limit

    최대값: [100]

    조회결과 최대건수

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

    DEFAULT 10

    offset

    최대값: [8000]

    조회결과 시작위치

    조회결과 시작위치

    Get a products memo

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/memos/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos/12' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memo": {
            "memo_no": 12,
            "author_id": "subadmin1",
            "created_date": "2018-01-18T11:19:27+09:00",
            "memo": "This is a sample memo."
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    memo_no
    Required

    메모 번호

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

    Create a products memo

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/memos'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "author_id": "subadmin1",
            "memo": "This is a sample memo."
        }
    }'
    

    Response example:

    {
        "memo": {
            "memo_no": 7,
            "author_id": "subadmin1",
            "created_date": "2018-01-18T11:19:27+09:00",
            "memo": "This is a sample memo."
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    author_id
    Required

    최대글자수 : [20자]

    작성자 아이디

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

    memo
    Required

    메모

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

    Update a products memo

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/memos/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos/7' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "author_id": "subadmin2",
            "memo": "Curabitur mollis consequat ipsum ac."
        }
    }'
    

    Response example:

    {
        "memo": {
            "memo_no": 7,
            "author_id": "subadmin2",
            "created_date": "2018-01-18T11:19:27+09:00",
            "memo": "Curabitur mollis consequat ipsum ac."
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    memo_no
    Required

    메모 번호

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

    author_id
    Required

    최대글자수 : [20자]

    작성자 아이디

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

    memo
    Required

    메모

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

    Delete a products memo

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/memos/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos/12' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "memo": {
            "memo_no": 12
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    memo_no
    Required

    메모 번호

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

    Products options

    Products options properties

    Attribute Description
    product_no
    Required

    상품번호

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

    shop_no

    멀티쇼핑몰 번호

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

    has_option

    옵션 사용여부

    T : 사용함
    F : 사용안함

    option_type

    옵션 구성방식

    옵션을 사용할 경우, 옵션의 유형 표시

    ● 조합형 : 옵션명을 기준으로 옵션값을 조합할 수 있음
    ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음.
    ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨.

    T : 조합형
    E : 연동형
    F : 독립형

    option_list_type

    옵션 표시방식

    조합형 옵션을 사용할 경우, 조합형 옵션의 유형 표시

    * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨
    * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음

    독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨.

    C : 일체형
    S : 분리형

    option_preset_code

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

    옵션세트 코드

    상품연동형 옵션을 사용할 경우, 옵션 세트 코드 표시

    option

    옵션

    해당 상품의 옵션명과 옵션값 표시

    select_one_by_option

    옵션별로 한 개씩 선택 (독립형 옵션)

    독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함.

    T : 사용함
    F : 사용안함

    option_preset_name

    연동형 옵션 세트명

    상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 표시

    use_additional_option

    추가입력 옵션 사용여부

    T : 사용함
    F : 사용안함

    additional_option

    추가입력 옵션

    use_attached_file_option

    파일 첨부 옵션 사용여부

    T : 사용함
    F : 사용안함

    attached_file_option

    파일 첨부 옵션

    Create a products option

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

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/options'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "has_option": "T",
            "option_type": "T",
            "option_list_type": "S",
            "option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                }
            ],
            "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
            }
        }
    }'
    

    Response example:

    {
        "option": {
            "shop_no": 1,
            "product_no": 24,
            "has_option": "T",
            "option_type": "T",
            "option_list_type": "S",
            "option_preset_code": "",
            "option": [
                {
                    "option_code": "",
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black",
                            "option_image_file": "",
                            "option_color": "",
                            "value_no": null
                        },
                        {
                            "option_text": "Red",
                            "option_image_file": "",
                            "option_color": "",
                            "value_no": null
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                }
            ],
            "select_one_by_option": "F",
            "option_preset_name": "",
            "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 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    has_option

    옵션 사용여부

    T : 사용함
    F : 사용안함

    option_type

    옵션 구성방식

    옵션을 사용할 경우, 옵션의 유형 입력

    ● 조합형 : 옵션명을 기준으로 옵션값을 조합할 수 있음
    ● 상품 연동형 : 옵션표시방식은 조합형과 유사하지만 필수옵션과 선택옵션을 선택할 수 있음. 옵션의 조합을 제한 없이 생성할 수 있음.
    ● 독립 선택형 : 독립적인 조건 여러개를 각각 선택할 수 있는 옵션으로 옵션 값이 조합되지 않고 각각의 품목으로 생성됨.

    T : 조합형
    E : 연동형
    F : 독립형

    option_list_type

    옵션 표시방식

    조합형 옵션을 사용할 경우, 조합형 옵션의 유형 입력

    * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨
    * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음

    독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨.

    S : 조합 분리선택형
    C : 조합 일체선택형

    option

    옵션

    해당 상품의 옵션명과 옵션값 입력

    select_one_by_option

    옵션별로 한 개씩 선택 (독립형 옵션)

    독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함.

    T : 사용함
    F : 사용안함 독립형에만 존재 체크시 옵션별로 한개씩 선택 값 처리

    option_preset_name

    연동형 옵션 세트명

    상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 입력

    use_additional_option

    추가입력 옵션 사용여부

    T : 사용함
    F : 사용안함

    additional_option

    추가입력 옵션

    use_attached_file_option

    파일 첨부 옵션 사용여부

    T : 사용함
    F : 사용안함

    attached_file_option

    파일 첨부 옵션

    Update a products option

    상품 옵션 수정 API는 옵션을 수정하면서 품목을 초기화하지 않습니다. 옵션명과 옵션값, 추가입력 옵션과 파일첨부 옵션의 수정만 가능하며, 옵션 항목을 추가하거나 삭제할 수는 없습니다.

    옵션을 추가하거나 삭제하고 싶을 경우에는 옵션 삭제 API로 삭제하신 다음, 다시 등록하셔야 합니다.

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/options'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "option_list_type": "S",
            "original_option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                },
                {
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_text": "Small"
                        },
                        {
                            "option_text": "Large"
                        }
                    ]
                }
            ],
            "option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                },
                {
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_text": "Small"
                        },
                        {
                            "option_text": "Large"
                        }
                    ]
                }
            ],
            "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
            }
        }
    }'
    

    Response example:

    {
        "option": {
            "shop_no": 1,
            "product_no": 24,
            "has_option": "T",
            "option_type": "T",
            "option_list_type": "S",
            "option_preset_code": "",
            "option": [
                {
                    "option_code": "",
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
                            "option_color": "#000000",
                            "option_text": "Black",
                            "value_no": null
                        },
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
                            "option_color": "#007543",
                            "option_text": "Red",
                            "value_no": null
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                },
                {
                    "option_code": "",
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
                            "option_color": "#000000",
                            "option_text": "Small",
                            "value_no": null
                        },
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
                            "option_color": "#007543",
                            "option_text": "Large",
                            "value_no": null
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                }
            ],
            "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 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    option_list_type

    옵션 표시방식

    조합형 옵션을 사용할 경우, 조합형 옵션의 유형 입력

    * 조합 일체선택형 : 하나의 셀렉스박스(버튼 이나 라디오버튼)에 모든 옵션이 조합되어 표시됨
    * 조합 분리선택형 : 옵션을 각각의 셀렉스박스(버튼 이나 라디오버튼)로 선택할 수 있으며 옵션명을 기준으로 옵션값을 조합할 수 있음

    독립형이나 상품 연동형 옵션을 사용하고 있을 경우 S(분리형)로 입력됨.

    S : 조합 분리선택형
    C : 조합 일체선택형

    option_preset_code

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

    옵션세트 코드

    상품연동형 옵션을 사용할 경우, 옵션 세트 코드 입력

    option

    옵션

    수정할 옵션명과 옵션값 입력

    original_option

    수정되기전 옵션값

    수정할 원래 옵션명과 옵션값을 입력. 해당 필드는 수정할 기존의 옵션명과 옵션값을 입력해야하며, original_option에 입력한 옵션이 option에 입력한 옵션명과 옵션값으로 업데이트 된다.

    select_one_by_option

    옵션별로 한 개씩 선택 (독립형 옵션)

    독립형 옵션을 사용할 경우, 하나의 옵션을 여러개 중복하여 선택할 수 없고 한개씩만 선택 가능함.

    T : 사용함
    F : 사용안함 독립형에만 존재 체크시 옵션별로 한개씩 선택 값 처리

    option_preset_name

    연동형 옵션 세트명

    상품연동형 옵션을 사용할 경우, 옵션 세트의 이름 입력

    use_additional_option

    추가입력 옵션 사용여부

    T : 사용함
    F : 사용안함

    additional_option

    추가입력 옵션

    use_attached_file_option

    파일 첨부 옵션 사용여부

    T : 사용함
    F : 사용안함

    attached_file_option

    파일 첨부 옵션

    Delete a products option

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/options'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "option": {
            "product_no": 24
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    List all products option

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/options'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "option": {
            "shop_no": 1,
            "product_no": 7,
            "has_option": "T",
            "option_type": "E",
            "option_display_type": "S",
            "option_preset_code": "S000000A",
            "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",
            "option_preset_name": "",
            "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 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

    Products seo

    SEO는 검색엔진 최적화(Search Engine Optimization)의 약자로서 SEO API는 검색엔진에 상품이나 쇼핑몰이 더 잘 검색될 수 있도록 할 수 있습니다.
    상품의 하위 Entity로서 SEO API는 해당 상품의 검색엔진 최적화 설정을 할 수 있습니다.

    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 : 사용안함

    Get products seo

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/seo'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/seo' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "seo": {
            "shop_no": 1,
            "meta_title": "product title",
            "meta_author": "This is Author",
            "meta_description": "This is Description.",
            "meta_keywords": "This is Keyword.",
            "meta_alt": "image1, image2",
            "search_engine_exposure": "T"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Update a products seo

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/seo'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/seo' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "meta_title": "Updated title",
            "meta_author": "Updated Author",
            "meta_description": "Updated Description",
            "meta_keywords": "Updated Keywords",
            "meta_alt": "Upadted Alt Text",
            "search_engine_exposure": "T"
        }
    }'
    

    Response example:

    {
        "seo": {
            "shop_no": 1,
            "meta_title": "Updated title",
            "meta_author": "Updated Author",
            "meta_description": "Updated Description",
            "meta_keywords": "Updated Keywords",
            "meta_alt": "Upadted Alt Text",
            "search_engine_exposure": "T"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    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

    검색 엔진 노출 설정

    해당 상품을 검색엔진에 노출할 것인지 설정. '노출안함'으로 설정할 경우 해당 상품이 검색엔진에 노출되지 않는다.

    Products tags

    Products tags properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

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

    tag

    상품 태그

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

    Create a products tag

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/tags'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/tags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "tag": [
                "Tag1",
                "Tag2"
            ]
        }
    }'
    

    Response example:

    {
        "tag": {
            "shop_no": 1,
            "product_no": 7,
            "tag": [
                "Tag1",
                "Tag2"
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    tag
    Required

    상품 태그

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

    List all products tags

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/tags'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/tags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "tags": {
            "shop_no": 1,
            "tag": [
                "Tag1",
                "Tag2"
            ]
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Count all products tags

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/tags/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/tags/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Delete a products tag

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/tags/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/tags/Tag1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "tag": {
            "product_no": 7,
            "tag": "Tag1"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    tag

    상품 태그

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

    Products variants

    품목(Variants)은 쇼핑몰에서 판매되는 상품의 기본 단위입니다. 쇼핑몰은 일반적으로 고객에게 다양한 선택권을 제공하기 위해 같은 상품이지만 사이즈가 다르거나, 혹은 색상이 다른 품목들을 판매합니다.
    품목(Variants)의 {#id}는 "variants_code"입니다.
    품목은 다음과 같은 Entity를 하위 Entity로 갖고 있습니다.

    재고(Inventories)

    Products variants properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    variant_code

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

    품목코드

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

    option

    옵션

    품목의 옵션. 해당 품목이 어떤 옵션으로 이루어져있는지를 나타낸다. 고객이 상품 구매시 해당 옵션을 선택할 경우 현재 품목을 구매할 수 있다.

    custom_variant_code

    최대글자수 : [40자]

    자체 품목 코드

    사용자가 품목에 부여 가능한 코드. 재고 관리 등의 이유로 자체적으로 상품을 관리하고 있는 경우 사용함.

    display

    진열상태

    해당 품목을 진열할지 여부. 품목을 진열할 경우 상품 상세 또는 상품 목록에서 해당 품목을 선택할 수 있다. 품목이 진열되어있지 않을 경우 해당 품목이 표시되지 않으며 해당 품목을 구매할 수 없다.

    T : 판매함
    F : 판매안함

    selling

    판매상태

    해당 품목을 판매할지 여부. 진열은 되어있으나 판매는 하지 않을 경우 해당 품목은 "품절"로 표시되며 해당 품목을 구매할 수 없다. 품목이 "판매함" 상태여도 "진열안함"으로 되어있다면 해당 품목을 구매할 수 없다.

    T : 진열함
    F : 진열안함

    additional_amount

    추가금액

    해당 품목을 구매할 경우, 상품의 판매가에 더하여 지불해야하는 추가 가격.

    inventories

    재고 Entity

    품목의 재고 Entity

    duplicated_custom_variant_code

    자체품목코드 중복여부

    T : 중복됨
    F : 중복안됨

    product_no
    Required

    상품번호

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

    List all products variants

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variants": [
            {
                "shop_no": 1,
                "item_code": "P000000R000C",
                "option": [
                    {
                        "name": "Color",
                        "value": "Blue"
                    },
                    {
                        "name": "Size",
                        "value": "Small"
                    }
                ],
                "custom_variant_code": "",
                "display": "T",
                "selling": "T",
                "additional_amount": "0.00"
            },
            {
                "shop_no": 1,
                "item_code": "P000000R000D",
                "option": [
                    {
                        "name": "Color",
                        "value": "Red"
                    },
                    {
                        "name": "Size",
                        "value": "Small"
                    }
                ],
                "custom_variant_code": "",
                "display": "T",
                "selling": "T",
                "additional_amount": "0.00"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    Get a products variant

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants/P000000R000C' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variant": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "option": [
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "custom_variant_code": "",
            "display": "T",
            "selling": "T",
            "additional_amount": "0.00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    variant_code
    Required

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

    품목코드

    inventories
    embed

    재고 Entity


    조회시 Embed 파라메터를 사용하여 조회할 수 있다.

    Update a products variant

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/16/variants/P000000P000A' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "custom_variant_code": "OPTION_CUSTOM_CODE",
            "display": "T",
            "selling": "F",
            "additional_amount": -1000,
            "quantity": 15,
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "B",
            "display_soldout": "T"
        }
    }'
    

    Response example:

    {
        "variant": {
            "shop_no": 1,
            "variant_code": "P000000R000A",
            "option": [
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "custom_variant_code": "OPTION_CUSTOM_CODE",
            "duplicated_custom_variant_code": "F",
            "display": "T",
            "selling": "F",
            "additional_amount": -1000,
            "inventories": {
                "shop_no": 1,
                "variant_code": "P000000R000A",
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "B",
                "display_soldout": "T"
            }
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    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 : 품절표시 사용안함

    Delete a products variant

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/16/variants/P000000P000A' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variant": {
            "product_no": 16,
            "variant_code": "P000000P000A"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    product_no
    Required

    상품번호

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

    variant_code
    Required

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

    상품 품목 코드

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

    Update products variants

    한 상품의 여러 품목을 한번에 수정할 수 있는 품목 수정(멀티) API입니다.

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/16/variants' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": [
            {
                "variant_code": "P000000P000B",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "A",
                "display_soldout": "T"
            },
            {
                "variant_code": "P000000P000C",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "A",
                "display_soldout": "T"
            }
        ]
    }'
    

    Response example:

    {
        "variants": [
            {
                "shop_no": 1,
                "variant_code": "P000000P000B",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "option": [
                    {
                        "name": "Color",
                        "value": "Black"
                    }
                ],
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "inventories": {
                    "shop_no": 1,
                    "variant_code": "P000000P000B",
                    "quantity": 15,
                    "use_inventory": "T",
                    "important_inventory": "A",
                    "inventory_control_type": "B",
                    "display_soldout": "T"
                }
            },
            {
                "shop_no": 1,
                "variant_code": "P000000P000C",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "option": [
                    {
                        "name": "Color",
                        "value": "Red"
                    }
                ],
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "inventories": {
                    "shop_no": 1,
                    "variant_code": "P000000P000B",
                    "quantity": 15,
                    "use_inventory": "T",
                    "important_inventory": "A",
                    "inventory_control_type": "B",
                    "display_soldout": "T"
                }
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    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 : 품절표시 사용안함

    Products variants inventories

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

    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

    수량

    해당 품목에 판매가 가능한 재고 수량. 재고 수량은 주문 또는 결제시 차감되며, 품절 표시를 위하여 체크된다.

    List all products variants inventory

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants/{#id}/inventories'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants/P000000R000C/inventories' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "inventory": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "B",
            "display_soldout": "F",
            "quantity": 0
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 읽기권한 (READ_PRODUCT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no
    Required

    상품번호

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

    variant_code
    Required

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

    품목코드

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

    Update a products variants inventory

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants/{#id}/inventories'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants/P00000GR000A/inventories' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "A",
            "display_soldout": "T",
            "quantity": 3
        }
    }'
    

    Response example:

    {
        "inventory": {
            "shop_no": 1,
            "variant_code": "P00000GR000A",
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "A",
            "display_soldout": "T",
            "quantity": 3
        }
    }
    

    기본스펙

    Property Description
    SCOPE 상품 쓰기권한 (WRITE_PRODUCT)
    호출건수 제한 30

    요청사양

    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

    수량

    해당 품목에 판매가 가능한 재고 수량. 재고 수량은 주문 또는 결제시 차감되며, 품절 표시를 위하여 체크된다.

    Reports salesvolume

    판매수량(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

    timezone

    최종 데이터 갱신 시간

    판매 수량 통계 데이터가 갱신된 시간 표시

    variants_code

    품목코드

    해당 품목의 품목 코드

    product_no

    상품번호

    total_sales

    총 판매 건수

    해당 품목이 검색한 기간 동안 총 판매된 수량

    Get sales volume

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reports/salesvolume'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reports/salesvolume?variants_code=P0000BKE000A&product_no=16&start_date=2018-10-27 14:10:00&end_date=2018-10-28 14:10:59' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "salesvolume": [
            {
                "shop_no": "1",
                "collection_date": "2018-10-27",
                "collection_hour": "12",
                "product_price": "10000.00",
                "product_option_price": "0.00",
                "settle_count": "2",
                "exchane_product_count": "0",
                "cancel_product_count": "0",
                "return_product_count": "0",
                "updated_date": "2018-10-27T14:51+09:00",
                "product_no": 16,
                "variants_code": "P0000BKE000A",
                "change_cancel_product_count": "0",
                "total_sales": "2"
            },
            {
                "shop_no": "1",
                "collection_date": "2018-10-27",
                "collection_hour": "12",
                "product_price": "10000.00",
                "product_option_price": "0.00",
                "settle_count": "23",
                "exchane_product_count": "0",
                "cancel_product_count": "0",
                "return_product_count": "0",
                "updated_date": "2018-10-27T14:51+09:00",
                "product_no": 16,
                "variants_code": "P0000BKE000B",
                "change_cancel_product_count": "0",
                "total_sales": "23"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 매출통계 읽기권한 (READ_SALESREPORT)
    호출건수 제한 30

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    product_no

    상품번호

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

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

    variants_code

    품목코드

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

    category_no

    분류 번호

    판매 수량 중 특정 카테고리에서 판매된 수량 조회

    mobile

    모바일 PC 여부

    판매 수량 중 모바일 웹에서 판매된 수량 조회

    T : 모바일
    F : 그외

    delivery_type

    배송 유형

    판매 수량 중 국내 또는 해외 배송 수량 조회

    A : 국내
    B : 해외

    customer_group_no

    회원 등급 번호

    판매 수량 중 특정 회원 등급에서 주문한 수량 조회

    supplier_id

    최대글자수 : [20자]

    공급사 아이디

    판매 수량 중 특정 공급사 ID로 등록된 수량 조회

    start_date
    Required

    날짜
    timezone

    검색 시작일

    판매 수량을 조회할 검색 시작일(주문일 기준)
    검색 종료일과 같이 사용해야함.

    end_date
    Required

    날짜
    timezone

    검색 종료일

    판매 수량을 조회할 검색 종료일(주문일 기준)
    검색 시작일과 같이 사용해야함.

    Reviews

    리뷰톡톡(Reviews)은 상품이나 서비스를 사용한 뒤 쇼핑몰의 고객들이 사용후기를 남길 수 있는 서비스를 의미합니다. 리뷰톡톡 API를 사용하기 위해서는 먼저 쇼핑몰에서 리뷰톡톡 서비스를 사용하고 있는지 확인이 필요합니다.

    Reviews properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    product_no

    상품번호

    review_no

    리뷰 번호

    order_id

    주문번호

    주문 번호

    nickname

    작성자 별명

    title

    리뷰 제목

    content

    리뷰 내용

    content_text_length

    리뷰글 텍스트 길이

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    writer

    작성자명

    writing_id

    작성자 회원 아이디

    created_date

    날짜
    timezone

    작성일자

    comment_count

    댓글 갯수

    like_count

    최소값: [0]

    좋아요 횟수

    share_count

    최소값: [0]

    SNS 공유 횟수

    hit_count

    최소값: [0]

    조회수

    additional_information

    추가 항목

    images

    첨부 이미지

    리뷰에 첨부하는 이미지

    tags

    해시태그

    rating

    평점

    use_share

    SNS 공유 여부

    리뷰의 SNS 공유 여부

    T : 공유함
    F : 공유안함

    display

    게시 여부

    리뷰의 게시 여부

    T : 게시함
    F : 게시안함

    deleted

    삭제 여부

    T : 삭제됨
    F : 삭제되지 않음

    Create a review

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/reviews'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "writing_id": "user",
            "input_channel": "P",
            "content": "#recommend #popular product.",
            "item_code": "P000000J000A",
            "images": [
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/20\/6660b56b72d3633c83744eb4d4b53209.PNG",
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/26\/c5fd9f37eab7a37eb4aed1f0ee38879e.jpg"
            ],
            "additional_information": [
                "170~180",
                "95"
            ],
            "order_id": "20180116-0000026",
            "use_share": "F",
            "product_no": 10,
            "rating": "4.0",
            "tags": [
                "recommend",
                "popular"
            ]
        }
    }'
    

    Response example:

    {
        "review": {
            "shop_no": 1,
            "product_no": 10,
            "review_no": 106,
            "order_id": "20180116-0000026",
            "nickname": "",
            "title": "#recommend #popular product.",
            "content": "#recommend #popular product.",
            "content_text_length": 28,
            "input_channel": "P",
            "writer": "John Doe",
            "writing_id": "user",
            "created_date": "2018-01-22T10:46:51+09:00",
            "comment_count": 0,
            "like_count": 0,
            "share_count": 0,
            "hit_count": 0,
            "additional_information": [
                {
                    "item_name": "Height",
                    "item_value": "170~180"
                },
                {
                    "item_name": "Size",
                    "item_value": "95"
                }
            ],
            "images": [
                {
                    "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                    "size": 143543,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                    "thumb": {
                        "size": 222879,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "width": 300,
                        "height": 409,
                        "tiny": {
                            "size": 12104,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                        }
                    }
                },
                {
                    "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                    "size": 83742,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                    "thumb": {
                        "size": 7779,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "width": 300,
                        "height": 200,
                        "tiny": {
                            "size": 1983,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                        }
                    }
                }
            ],
            "tags": [
                "recommend",
                "popular"
            ],
            "rating": 4,
            "use_share": "F",
            "display": "T",
            "deleted": "F"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 쓰기권한 (WRITE_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    product_no
    Required

    상품번호

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

    order_id

    주문번호

    주문번호

    item_code
    Required

    품목코드

    리뷰를 작성할 상품의 품목코드

    content
    Required

    최대글자수 : [2000자]

    리뷰 내용

    rating

    평점

    DEFAULT 5

    additional_information

    추가항목

    images

    첨부 이미지

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    DEFAULT P

    use_share

    SNS 공유 여부

    T : 공유함
    F : 공유안함

    List all reviews

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "reviews": [
            {
                "shop_no": 1,
                "product_no": 10,
                "review_no": 1,
                "order_id": "20180116-0000001",
                "nickname": "",
                "title": "#recommend #popular product.",
                "content": "#recommend #popular product.",
                "content_text_length": 28,
                "input_channel": "P",
                "writer": "John Doe",
                "writing_id": "user1",
                "created_date": "2018-01-17T17:57:40+09:00",
                "comment_count": 0,
                "like_count": 0,
                "share_count": 0,
                "hit_count": 0,
                "additional_information": [
                    {
                        "item_name": "Height",
                        "item_value": "170~180"
                    },
                    {
                        "item_name": "Size",
                        "item_value": "95"
                    }
                ],
                "images": [
                    {
                        "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                        "size": 143543,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "thumb": {
                            "size": 222879,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                            "width": 300,
                            "height": 409,
                            "tiny": {
                                "size": 12104,
                                "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                            }
                        }
                    },
                    {
                        "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                        "size": 83742,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "thumb": {
                            "size": 7779,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                            "width": 300,
                            "height": 200,
                            "tiny": {
                                "size": 1983,
                                "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                            }
                        }
                    }
                ],
                "tags": [
                    "recommend",
                    "popular"
                ],
                "rating": 3.5,
                "use_share": "F",
                "display": "T",
                "deleted": "T"
            },
            {
                "shop_no": 1,
                "product_no": 12,
                "review_no": 2,
                "order_id": "20180108-0000039",
                "nickname": "",
                "title": "Good Product.",
                "content": "Good!",
                "content_text_length": 8,
                "input_channel": "P",
                "writer": "John Doe",
                "writing_id": "user1",
                "created_date": "2018-01-08T11:46:56+09:00",
                "comment_count": 0,
                "like_count": 0,
                "share_count": 0,
                "hit_count": 0,
                "additional_information": "",
                "images": null,
                "tags": [],
                "rating": 1.5,
                "use_share": "T",
                "display": "T",
                "deleted": "F"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 읽기권한 (READ_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no

    리뷰 번호

    writing_id

    작성자 회원 아이디

    회원 아이디

    created_start_date

    날짜
    timezone

    작성일 검색 시작일

    리뷰 작성일 기준 검색의 검색 시작일
    검색 종료일과 같이 사용해야함

    created_end_date

    날짜
    timezone

    작성일 검색 종료일

    리뷰 작성일 기준 검색의 검색 종료일
    검색 시작일과 같이 사용해야함

    deleted

    삭제된 리뷰글 여부

    리뷰가 삭제되었는지 여부

    T : 삭제됨
    F : 삭제되지 않음

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    T : 댓글이 작성된 리뷰만 검색
    F : 댓글이 작성되지 않은 리뷰만 검색

    has_image

    이미지가 첨부된 리뷰만 검색

    T : 이미지가 첨부된 리뷰만 검색
    F : 이미지가 첨부되지 않은 리뷰만 검색

    search_key

    검색 대상 항목

    writer : 작성자명
    writing_id : 작성자 회원 아이디
    content : 리뷰 내용
    product_no : 상품 번호
    product_name : 상품명
    product_code : 상품 코드

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    limit

    최소값: [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    최소값: [0]

    목록을 가져올 시작 위치

    조회결과 시작위치

    Get a review

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "review": {
            "shop_no": 1,
            "product_no": 10,
            "review_no": 1,
            "order_id": "20180116-0000001",
            "nickname": "",
            "title": "#recommend #popular product.",
            "content": "#recommend #popular product.",
            "content_text_length": 16,
            "input_channel": "P",
            "writer": "John Doe",
            "writing_id": "user1",
            "created_date": "2018-01-17T17:57:40+09:00",
            "comment_count": 0,
            "like_count": 0,
            "share_count": 0,
            "hit_count": 0,
            "additional_information": [
                {
                    "item_name": "Height",
                    "item_value": "170~180"
                },
                {
                    "item_name": "Size",
                    "item_value": "95"
                }
            ],
            "images": [
                {
                    "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                    "size": 143543,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                    "thumb": {
                        "size": 222879,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "width": 300,
                        "height": 409,
                        "tiny": {
                            "size": 12104,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                        }
                    }
                },
                {
                    "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                    "size": 83742,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                    "thumb": {
                        "size": 7779,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "width": 300,
                        "height": 200,
                        "tiny": {
                            "size": 1983,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                        }
                    }
                }
            ],
            "tags": [
                "recommend",
                "popular"
            ],
            "rating": 2.5,
            "use_share": "F",
            "display": "T",
            "deleted": "T"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 읽기권한 (READ_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    Count all reviews

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 읽기권한 (READ_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    writing_id

    작성자 회원 아이디

    회원 아이디

    created_start_date

    날짜
    timezone

    작성일 검색 시작일

    리뷰 작성일 기준 검색의 검색 시작일
    검색 종료일과 같이 사용해야함

    created_end_date

    날짜
    timezone

    작성일 검색 종료일

    리뷰 작성일 기준 검색의 검색 종료일
    검색 시작일과 같이 사용해야함

    deleted

    삭제된 리뷰글 여부

    리뷰가 삭제되었는지 여부

    T : 삭제됨
    F : 삭제되지 않음

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    T : 댓글이 작성된 리뷰만 검색
    F : 댓글이 작성되지 않은 리뷰만 검색

    has_image

    이미지가 첨부된 리뷰만 검색

    T : 이미지가 첨부된 리뷰만 검색
    F : 이미지가 첨부되지 않은 리뷰만 검색

    search_key

    검색 대상 항목

    writer : 작성자명
    writing_id : 작성자 회원 아이디
    content : 리뷰 내용
    product_no : 상품 번호
    product_name : 상품명
    product_code : 상품 코드

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    Update a review

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "content": "#cool #best product review.",
            "rating": "3.0",
            "images": [
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/20\/6660b56b72d3633c83744eb4d4b53209.PNG",
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/26\/c5fd9f37eab7a37eb4aed1f0ee38879e.jpg"
            ],
            "additional_information": [
                "170~180",
                "95"
            ],
            "use_share": "T",
            "product_no": 10,
            "tags": [
                "cool",
                "best"
            ]
        }
    }'
    

    Response example:

    {
        "review": {
            "shop_no": 1,
            "product_no": 10,
            "review_no": 1,
            "order_id": "20180116-0000001",
            "nickname": "",
            "title": "#cool #best product review.",
            "content": "#cool #best product review.",
            "content_text_length": 27,
            "input_channel": "P",
            "writer": "John Doe",
            "writing_id": "user1",
            "created_date": "2018-01-17T17:57:40+09:00",
            "comment_count": 0,
            "like_count": 0,
            "share_count": 0,
            "hit_count": 0,
            "additional_information": [
                {
                    "item_name": "Height",
                    "item_value": "170~180"
                },
                {
                    "item_name": "Size",
                    "item_value": "95"
                }
            ],
            "images": [
                {
                    "name": "39a9e7d3892c58034cd2357f74e5b04f.PNG",
                    "size": 143543,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/5358112ce7e01d423597ccd51eeb415a.PNG",
                    "thumb": {
                        "size": 222879,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/5358112ce7e01d423597ccd51eeb415a.PNG",
                        "width": 300,
                        "height": 409,
                        "tiny": {
                            "size": 12104,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/5358112ce7e01d423597ccd51eeb415a.PNG"
                        }
                    }
                },
                {
                    "name": "82c5736941ee04e49a172f620b3f1685.jpg",
                    "size": 83742,
                    "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/820ca38030768fc4dcc88789f75341c3.jpg",
                    "thumb": {
                        "size": 7779,
                        "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_list\/820ca38030768fc4dcc88789f75341c3.jpg",
                        "width": 300,
                        "height": 200,
                        "tiny": {
                            "size": 1983,
                            "path": "https:\/\/cafe24-reviewtalktalk-seoul.s3.ap-northeast-2.amazonaws.com\/sampleid\/2018\/03\/26\/thumb_tiny\/820ca38030768fc4dcc88789f75341c3.jpg"
                        }
                    }
                }
            ],
            "tags": [
                "cool",
                "best"
            ],
            "rating": 3,
            "use_share": "T",
            "display": "T",
            "deleted": "T"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 쓰기권한 (WRITE_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    content

    최대글자수 : [2000자]

    리뷰 내용

    rating

    평점

    additional_information

    추가항목

    images

    첨부 이미지

    리뷰에 첨부하는 이미지

    use_share

    SNS 공유 여부

    리뷰의 SNS 공유 여부

    T : 공유함
    F : 공유안함

    Delete a review

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "review": {
            "review_no": 1
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 쓰기권한 (WRITE_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    Reviews comments

    댓글(Comments)은 리뷰에 대한 다른 고객들이나 쇼핑몰 운영자의 반응을 나타냅니다. 댓글은 리뷰에 속해있는 하위 Entity입니다.

    Reviews comments properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    review_no

    리뷰 번호

    comment_no

    댓글 번호

    content

    댓글 내용

    writer

    작성자명

    nickname

    작성자 별명

    ip

    IP

    작성자의 IP 주소

    writing_id

    작성자 회원 아이디

    created_date

    날짜
    timezone

    작성 일자

    Create a reviews comment

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "writing_id": "user1",
            "content": "sample comment."
        }
    }'
    

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 쓰기권한 (WRITE_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    writing_id

    작성자 회원 아이디

    content
    Required

    댓글 내용

    List all reviews comments

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "comments": [
            {
                "shop_no": 1,
                "review_no": 1,
                "comment_no": 12,
                "content": "sample comment.",
                "writer": "John Doe",
                "nickname": "Cool john dude",
                "ip": "127.0.0.1",
                "writing_id": "user1",
                "created_date": "2018-01-22T15:52:51+09:00"
            },
            {
                "shop_no": 1,
                "review_no": 1,
                "comment_no": 11,
                "content": "sample comment.",
                "writer": "John Doe",
                "nickname": "Cool john dude",
                "ip": "127.0.0.1",
                "writing_id": "user1",
                "created_date": "2018-01-22T15:51:39+09:00"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 읽기권한 (READ_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    limit

    최소값: [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    최소값: [0]

    목록을 가져올 시작 위치

    조회결과 시작위치

    Get a reviews comment

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments/11' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 읽기권한 (READ_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    Update a reviews comment

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments/11' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "content": "modify sample comment."
        }
    }'
    

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "modify sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 쓰기권한 (WRITE_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    content
    Required

    댓글 내용

    Delete a reviews comment

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}/comments/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments/11' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "comment": {
            "review_no": 1,
            "comment_no": 11
        }
    }
    

    기본스펙

    Property Description
    SCOPE 게시판 쓰기권한 (WRITE_COMMUNITY)
    호출건수 제한 100

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    Scripttags

    스크립트(Scripttags)는 앱에서 쇼핑몰의 특정 화면(Page)에 원격에 위치한 스크립트를 설치하기 위해 사용할 수 있는 API입니다. 스크립트 API를 사용해 쇼핑몰의 디자인을 변경하지 않고 쇼핑몰 화면에 기능을 쉽게 추가할 수 있습니다.

    스크립트(Scripttags)의 {#id}는 "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" 일 경우 전체 페이지에 스크립트가 적용됨.

    화면경로 코드표

    skin_no

    스킨 번호

    스크립트를 적용할 스킨 번호

    created_date

    timezone

    생성일

    스크립트 설치 날짜

    updated_date

    timezone

    수정일

    스크립트 수정 날짜

    List all scripttags

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "scripttags": [
            {
                "shop_no": 1,
                "script_no": "1509432821494844",
                "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
                "src": "https:\/\/js-aplenty.com\/bar.js",
                "display_location": [
                    "BOARD_FREE_LIST"
                ],
                "skin_no": [
                    1,
                    2
                ],
                "created_date": "2017-10-31T15:53:41+09:00",
                "updated_date": "2017-11-03T18:05:32+09:00"
            },
            {
                "shop_no": 1,
                "script_no": "1509699932016345",
                "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
                "src": "https:\/\/js-aplenty.com\/bar.js",
                "display_location": [
                    "PRODUCT_LIST",
                    "PRODUCT_DETAIL"
                ],
                "skin_no": null,
                "created_date": "2017-11-03T18:05:32+09:00",
                "updated_date": "2017-11-03T18:05:32+09:00"
            }
        ]
    }
    

    기본스펙

    Property Description
    SCOPE 앱 읽기권한 (READ_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    script_no

    script의 고유번호

    스크립트의 고유 번호 검색

    src

    URL

    원본 script 경로

    원본 스크립트 경로 검색

    display_location

    화면 경로

    스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함.
    (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨)

    화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 "디자인관리 > 쇼핑몰 환경설정 > 화면경로 > 화면경로 설정"에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음.

    "all" 일 경우 전체 페이지에 스크립트가 적용됨.

    화면경로 코드표

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

    skin_no

    스킨 번호

    스크립트를 적용할 스킨 번호

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

    created_start_date

    날짜
    timezone

    스크립트 설치일 검색 시작일

    스크립트 설치 날짜가 해당 날짜 이후인 스크립트 검색
    검색 종료일과 같이 사용해야함.

    created_end_date

    날짜
    timezone

    스크립트 설치일 검색 종료일

    스크립트 설치 날짜가 해당 날짜 이전인 스크립트 검색
    검색 시작일과 같이 사용해야함.

    updated_start_date

    날짜
    timezone

    스크립트 수정일 검색 시작일

    스크립트 수정 날짜가 해당 날짜 이후인 스크립트 검색
    검색 종료일과 같이 사용해야함.

    updated_end_date

    날짜
    timezone

    스크립트 수정일 검색 종료일

    스크립트 수정 날짜가 해당 날짜 이전인 스크립트 검색
    검색 시작일과 같이 사용해야함.

    Count all scripttags

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/count'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/count' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    기본스펙

    Property Description
    SCOPE 앱 읽기권한 (READ_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    script_no

    script의 고유번호

    스크립트의 고유 번호 검색

    src

    URL

    원본 script 경로

    원본 스크립트 경로 검색

    display_location

    화면 경로

    스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함.
    (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨)

    화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 "디자인관리 > 쇼핑몰 환경설정 > 화면경로 > 화면경로 설정"에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음.

    "all" 일 경우 전체 페이지에 스크립트가 적용됨.

    화면경로 코드표

    skin_no

    스킨 번호

    스크립트를 적용할 스킨 번호.

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

    created_start_date

    날짜
    timezone

    스크립트 설치일 검색 시작일

    스크립트 설치 날짜가 해당 날짜 이후인 스크립트 검색
    검색 종료일과 같이 사용해야함.

    created_end_date

    날짜
    timezone

    스크립트 설치일 검색 종료일

    스크립트 설치 날짜가 해당 날짜 이전인 스크립트 검색
    검색 종료일과 같이 사용해야함.

    updated_start_date

    날짜
    timezone

    스크립트 수정일 검색 시작일

    스크립트 수정 날짜가 해당 날짜 이후인 스크립트 검색
    검색 종료일과 같이 사용해야함.

    updated_end_date

    날짜
    timezone

    스크립트 수정일 검색 종료일

    스크립트 수정 날짜가 해당 날짜 이전인 스크립트 검색
    검색 시작일과 같이 사용해야함.

    Get a scripttag

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/{#id}'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/1509699932016345' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1509699932016345",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-11-03T18:05:32+09:00",
            "updated_date": "2017-11-03T18:05:32+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 앱 읽기권한 (READ_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    script_no

    script의 고유번호

    스크립트의 고유 번호 검색

    Create a scripttag

    Definition

    POST 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags'
    

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ]
        }
    }'
    

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1527128695613925",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\\\/\\\/js-aplenty.com\\\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-03-15T13:27:53+09:00",
            "updated_date": "2017-03-15T13:27:53+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 앱 쓰기권한 (WRITE_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    src
    Required

    URL

    원본 script 경로

    설치할 스크립트의 원본 경로(절대 경로)

    display_location
    Required

    화면 경로

    스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함.
    (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨)

    화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 "디자인관리 > 쇼핑몰 환경설정 > 화면경로 > 화면경로 설정"에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음.

    "all" 일 경우 전체 페이지에 스크립트가 적용됨.

    화면경로 코드표

    skin_no

    스킨 번호

    스크립트를 적용할 스킨 번호.

    Update a scripttag

    Definition

    PUT 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/{#id}'
    

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/1509699932016345' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ]
        }
    }'
    

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1509432821494844",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-10-31T15:53:41+09:00",
            "updated_date": "2017-11-06T10:33:57+09:00"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 앱 쓰기권한 (WRITE_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

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

    DEFAULT 1

    script_no
    Required

    script의 고유번호

    스크립트의 고유 번호

    src

    URL

    원본 script 경로

    설치할 스크립트의 원본 경로(절대 경로)

    display_location

    화면 경로

    스크립트를 표시할 "화면 경로". 화면 경로는 화면의 페이지 경로가 아니라 쇼핑몰의 각 페이지에 부여된 특정한 역할을 의미함.
    (예 : 상품분류(product_list)에 스크립트를 삽입할 경우 쇼핑몰에서 상품분류로 사용되는 모든 페이지에 스크립트가 노출됨)

    화면의 역할은 해당 페이지에 사용된 모듈에 따라 자동으로 부여됨. 임의의 페이지에 상품분류 모듈을 추가하면 해당 페이지는 "상품분류" 역할로 인식된다. 쇼핑몰 관리자 화면의 "디자인관리 > 쇼핑몰 환경설정 > 화면경로 > 화면경로 설정"에서 각 페이지에 부여된 화면 역할을 조회하고 설정할 수 있음.

    "all" 일 경우 전체 페이지에 스크립트가 적용됨.

    화면경로 코드표

    skin_no

    스킨 번호

    스크립트를 적용할 스킨 번호.

    Delete a scripttag

    ※ 멀티쇼핑몰별로 삭제하려면 엔드포인트 뒤에 "?shop_no=N"을 추가하면 됩니다.

    Definition

    DELETE 'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/{#id}'
    

    Request example:

    curl -X DELETE \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/1509699932016345' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "scripttag": {
            "script_no": "1509699932016345"
        }
    }
    

    기본스펙

    Property Description
    SCOPE 앱 쓰기권한 (WRITE_APPLICATION)
    호출건수 제한 10

    요청사양

    Parameter Description
    script_no
    Required

    script의 고유번호

    스크립트의 고유 번호

    Shops

    멀티쇼핑몰(Shops)은 두개 이상의 쇼핑몰을 운영하고 있는 경우 생성한 멀티 쇼핑몰의 정보입니다. 멀티쇼핑몰은 최대 5개까지 생성이 가능하며, 각각 다른 언어와 화폐로 생성할 수 있어 다국어 쇼핑몰을 운영할 때 사용할 수 있습니다.
    멀티쇼핑몰(Shops)의 {#id}는 "shop_no"입니다.

    Shops properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

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

    default

    기본샵 여부

    기본샵 여부 구분

    T : 기본샵
    F : 기본샵 아님

    shop_name

    최대글자수 : [255자]

    쇼핑몰명

    쇼핑몰 이름

    language_code

    언어 코드

    멀티쇼핑몰의 기본 언어 코드

    ko_KR : 국문
    en_US : 영문
    zh_CN : 중문(간체)
    zh_TW : 중문(번체)
    ja_JP : 일문

    language_name

    최대글자수 : [20자]

    기본 언어명

    멀티쇼핑몰의 기본 언어명

    currency_code

    형식 : [A-Z]

    결제 화폐 코드

    멀티쇼핑몰의 결제 화폐 코드

    KRW : ₩ 원 (한국)
    USD : $ 달러 (미국)
    JPY : ¥ 엔 (일본)
    CNY : ¥ 위엔 (중국)
    TWD : $NT 달러 (타이완)
    EUR : € 유로 (유럽)
    BRL : R$ 헤알 (브라질)

    currency_name

    결제 화폐명

    멀티쇼핑몰의 결제 화폐명

    reference_currency_code

    형식 : [A-Z]

    참조 화폐 코드

    멀티쇼핑몰의 참조 화폐 코드

    KRW : ₩ 원 (한국)
    USD : $ 달러 (미국)
    JPY : ¥ 엔 (일본)
    CNY : ¥ 위엔 (중국)

    reference_currency_name

    참조 화폐명

    멀티쇼핑몰의 참조 화폐명

    pc_skin_no

    PC 쇼핑몰 대표 디자인 번호

    멀티쇼핑몰의 PC 쇼핑몰 대표 디자인 번호. 현재 쇼핑몰에서 사용하고 있는 디자인 번호를 나타낸다.

    mobile_skin_no

    모바일 쇼핑몰 대표 디자인 번호

    모바일 쇼핑몰 대표 디자인 번호. 현재 쇼핑몰에서 사용하고 있는 디자인 번호를 나타낸다.

    base_domain

    최대글자수 : [63자]

    기본제공 도메인

    기본제공하는 도메인

    primary_domain

    최대글자수 : [63자]

    대표도메인

    멀티쇼핑몰 대표 도메인

    slave_domain

    연결 도메인

    쇼핑몰에 연결된 도메인

    active

    활성화 여부

    멀티쇼핑몰 활성화 여부

    T : 활성화
    F : 비활성화

    List all shops

    Definition

    GET 'https://{mallid}.cafe24api.com/api/v2/admin/shops'
    

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/shops' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "shops": [
            {
                "shop_no": 1,
                "default": "T",
                "shop_name": "My Shop",
                "language_code": "ko_KR",
                "language_name": "Korean",
                "currency_code": "KRW",
                "currency_name": "₩ Won (Korea)",
                "reference_currency_code": "",
                "reference_currency_name": null,
                "pc_skin_no": 1,
                "mobile_skin_no": 2,
                "base_domain": "sampleid.cafe24.com",
                "primary_domain": "samplemall.com",
                "slave_domain": [
                    "sampledomain1.com",
                    "ko.sampledomain1.com"
                ],
                "active": "T"
            },
            {
                "sho