닫기
  • Shop

  • Product

    non-print

    API Index

    Introduction

    D.Collection API (Beta)

    D.Collection APIs can only be used by Cafe24-approved partners for developing marketing and ad services to help users increase sales in their Cafe24 store.

    Information obtain through the APIs cannot be used for unauthorized purposes.

    Cafe24 uses the Basic Auth based authentication system, the standard HTTP request method, easy-to-understand endpoint URLs, and HTTP code-based error messages for its D.Collection APIs.

    Request/Response Format

    • API request and response support JSON format.

    • For privacy protection purposes, Cafe 24 API only supports HTTPS protocol.

    • Dates properties are provided in the ISO_8601 format. : YYYY-MM-DDTHH:MM:SS + 09:00

    • We follow ISO_4217 format for payment currency codes.

    Request Example (search)
    Right response example
    {
      "resource": {
          "key": "value",
          "key": "value"
       }
    }
    Error response example
    {
      "error": {
          "code": "error code",
          "message": "error message",
          "more_info": {
          }
      }
    }

    Method

    Each resources support Create, Read, Update, and Delete and API can be used by using standard HTTP method.

    • GET : Read data the resource.

    D.Collection API Intro

    D.Collection API

    Develop a service that allows users to boost sales of stores by retrieving store and product data that are part of the D.Collection program.

    example
    Retrieve a store : https://dcollection-api.cafe24.com/api/shops
    Retrieve a product : https://dcollection-api.cafe24.com/api/products?dcollection_product_category={dcollection_product_category}

    API Status Code

    Code Case Solutions
    200 When GET success
    401 1) When you call APIs without an Access Token
    2) When an Access Token is invalid
    3) If a client who requested for verification has invalid permission
    Check whether the request was made with a valid Access Token.
    404 1) When you call the wrong API URL
    2) When the resource cannot be found
    Check the API documentation to see if there are any errors in the endpoint URL.
    422 When the retrieve or process request values are not the same as the specifications.
    2) Invalid input value in the required field.
    Check the API documentation to see if any required parameters are missing or if you input invalid values.
    429 API calls from the client side have exceeded the limit. (40 times per minute.) Try again later to reset the API request limits.
    500 Internal server error, unknown error Contact us via Cafe24 Developers.
    503 Currently the server is down Contact us via Cafe24 Developers.
    504 Request timeout A temporary error has occurred, causing response delays. Please try again later.

    How to use GET API

    D.Collection API provides several ways to get the data.

    The following describes the different ways to recall data using various parameters when inquiring an API.

    1. Add search conditions

    You can use search conditions by adding parameters to an endpoint.

    If you want to use multiple search conditions, separate them with ampersands (&).

    You can also specify a date and time if it is supported by the API you are using.

    Add search conditions
    E.g. Retrieve a store with a specific name
    GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly
    
    E.g. Retrieve a store with a specific name and properties
    GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly&shop_properties=hartebeest
    
    E.g. Retrieve products under a specific category
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802
    
    E.g. Retrieve products under a specific category and a store name
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&shop_name=안다르

    2. Use commas to search for more than one item

    Use commas to search for data for more than one item. (You can search for up to 100 items in one query.)

    The search conditions separated by commas are OR conditions; You can view all data corresponding to the conditions.

    Use commas to search for more than one item
    E.g. Retrieve stores with specific names
    GET https://dcollection-api.cafe24.com/api/shops?shop_name=nelly,reseda
    
    E.g. Retrieve products under a specific category or specific product names
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&product_name=안다르,에어쿨링

    3. Pagination

    If there are too many results, you define the number of details returned in one response with the "limit" parameter.

    If you are not able to view all details with the maximum value of the "limit" parameter, you can use the "offset" parameter.

    Pagination
    E.g. When paging the details of 100 stores at a time
    GET https://dcollection-api.cafe24.com/api/shops?limit=100
    
    E.g. When paging the details of 100 products at a time
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&limit=100
    
    E.g. When retrieving details from the 201st to the 300th store
    GET https://dcollection-api.cafe24.com/api/shops?limit=100&offset=200
    
    E.g. When retrieving details from the 201st to the 300th product
    GET https://dcollection-api.cafe24.com/api/products?dcollection_product_category=C200802&limit=100&offset=200

    API Limit

    dcollection APIs use Laravel throttle middleware to limit the API calls to 40 times per minute per IP.

    A count will be deducted per request, and if your requests exceeds 40 times within a minute, then you will receive a 429 error (Too Many Requests Error).

    Check the X-RateLimit–Limit and the X-RateLimit–Remaining in the Header to avoid 429 errors.

    X-Api-Call-Limit : 1/40

    Authentication

    Authentication

    You can get a user token to actually call up the API using the issued authentication code.

    When authentication is succeed, you can use dcollection API data right away.

    • {client_id} : Enter the client_id of the app created in the developer center.

    • {client_secret} : Enter the client_secret for the app created at the developer center.

    access_token : This is the approach token used by clients to access the resource server.

    Example (request)
    Example (response)
    {
      "resource": {
          "key": "value",
          "key": "value"
       }
    }

    Shop

    Shops

    Endpoints

    Shops properties

    Attribute Description
    dcollection_store_category

    Standard D.Collection store category

    store_id

    Store ID

    shop_name

    Store name

    shop_no

    Shop (multi-language store) number

    shop_url

    Primary domain of the store

    shop_currency_code

    Payment currency

    KRW : ₩ Korean won
    USD : $ US dollar
    JPY : ¥ Japanese yen
    PHP : ₱ Philippine peso

    shop_language

    Language of the store

    ko_KR : Korean
    en_US : English
    zh_CN : Chinese (Simplified)
    zh_TW : Chinese (Traditional)
    ja_JP : Japanese
    vi_VN : Vietnamese

    shop_grade

    Popularity of the store

    black : Popularity score 90 or higher
    purple : Popularity score 80 or higher
    green : Popularity score 70 or higher
    orange : Less than popularity score 70

    shop_popular_age

    Store's popularity by age

    teenager : Teens
    twenties : Twenties
    thirties : Thirties
    forties : Forties
    etc : Others

    shop_sex

    Store's popularity by gender

    F : Female
    M : Male

    shop_region

    Store's popularity by region

    Seoul
    Gyeonggi-do
    Incheon
    Gangwon-do
    Chungcheongbuk-do
    Sejong-si
    Chungcheongnam-do
    Daejeon
    Gyeongsangbuk-do
    Daegu
    Ulsan
    Busan
    Gyeongsangnam-do
    Jeollabuk-do
    Jeollanam-do
    Gwangju
    Jeju-do

    shop_tags

    Store tag codes

    social_logins

    Social media channels connected to the store

    facebook : Facebook
    kakao : Kakao
    naver : Naver
    line : Line
    google : Google
    apple : Apple

    use_cafe24pay

    Check whether the store is using Cafe24 Pay

    true : Enabled
    false : Disabled

    use_naverpay

    Check whether the store is using Naver Pay

    true : Enabled
    false : Disabled

    use_EMS

    Check whether the store is using Korean Post EMS

    true : Enabled
    false : Disabled

    shipping_fee_type

    Types of shipping fees offered by the store

    T : Free shipping
    R : Fixed fee
    M : By purchase amount
    D : Tiered shipping rates (by amount)
    W : Tiered shipping rate (by weight)
    C : Tiered shipping rate (by quantity)
    N : Quantity based shipping rate
    E : Automatically calculated rates (EMS) enabled
    F : Cash on Delivery

    benefits

    Customer benefits offered by the store

    DP : Limited time discount
    DR : Returning customer discount
    DQ : Bulk order discount
    DM : Customer discount
    DN : New product discount
    DV : Shipping fee discount
    PG : Gift
    PB : Buy one Get X free

    global_payment_type

    Global payment services supported by the store

    AX : AXES
    EX : eXimbay
    PP : PayPal
    CG : WeChat Pay
    EY : ECPAY
    PW : Paymentwall

    created_date

    Date

    Creation date of the store

    updated_date

    Date

    Updated date of the store

    Retrieve a list of stores

    GET

    Specification

    Property Description
    SCOPE dcollection.read_shop
    Request Limit 40

    Request

    Parameter Description
    dcollection_store_category

    Standard D.Collection store category

    shop_name

    Array Max : [3]

    Store name

    You can search multiple item with ,(comma)

    store_id

    Store ID

    shop_no

    Array Max : [3]

    Shop (multi-language store) number

    You can search multiple item with ,(comma)

    shop_currency_code

    Payment currency

    KRW : ₩ Korean won
    USD : $ US dollar
    JPY : ¥ Japanese yen
    PHP : ₱ Philippine peso

    shop_language

    Language of the store

    ko_KR : Korean
    en_US : English
    zh_CN : Chinese (Simplified)
    zh_TW : Chinese (Traditional)
    ja_JP : Japanese
    vi_VN : Vietnamese

    shop_grade

    Popularity of the store

    black : Popularity score 90 or higher
    purple : Popularity score 80 or higher
    green : Popularity score 70 or higher
    orange : Less than popularity score 70

    shop_popular_age

    Store's popularity by age

    teenager : Teens
    twenties : Twenties
    thirties : Thirties
    forties : Forties
    etc : Others

    shop_sex

    Store's popularity by gender

    F : Female
    M : Male

    shop_region

    Store's popularity by region

    Seoul
    Gyeonggi-do
    Incheon
    Gangwon-do
    Chungcheongbuk-do
    Sejong-si
    Chungcheongnam-do
    Daejeon
    Gyeongsangbuk-do
    Daegu
    Ulsan
    Busan
    Gyeongsangnam-do
    Jeollabuk-do
    Jeollanam-do
    Gwangju
    Jeju-do

    shop_tags

    Array Max : [10]

    Store tags

    You can search multiple item with ,(comma)

    use_cafe24pay

    Check whether the store is using Cafe24 Pay

    true : Enabled
    false : Disabled

    use_naverpay

    Check whether the store is using Naver Pay

    true : Enabled
    false : Disabled

    use_EMS

    Check whether the store is using Korean Post EMS

    true : Enabled
    false : Disabled

    social_logins

    Social media channels connected to the store

    facebook : Facebook
    kakao : Kakao
    naver : Naver
    line : Line
    google : Google
    apple : Apple

    shipping_fee_type

    Types of shipping fees offered by the store

    T : Free shipping
    R : Fixed fee
    M : By purchase amount
    D : Tiered shipping rates (by amount)
    W : Tiered shipping rate (by weight)
    C : Tiered shipping rate (by quantity)
    N : Quantity based shipping rate
    E : Automatically calculated rates (EMS) enabled
    F : Cash on Delivery

    benefits

    Customer benefits offered by the store

    DP : Limited time discount
    DR : Returning customer discount
    DQ : Bulk order discount
    DM : Customer discount
    DN : New product discount
    DV : Shipping fee discount
    PG : Gift
    PB : Buy one Get X free

    global_payment_type

    Global payment services supported by the store

    AX : AXES
    EX : eXimbay
    PP : PayPal
    CG : WeChat Pay
    EY : ECPAY
    PW : Paymentwall

    created_start_date

    Date

    Start date value of store creation date

    created_end_date

    Date

    End date value of store creation date

    limit

    Min : [1]~Max : [100]

    Maximum number of search results

    DEFAULT 10

    offset

    Min : [0]~Max : [5000]

    Starting location of search results

    DEFAULT 0

    sort

    Value of sort order

    created_date : Store creation date
    shop_name : Store name

    order

    Sort order

    asc : Ascending order
    desc : Descending order

    Retrieve a list of stores
    Request Copy
    Response Copy

    Product

    Products

    Products properties

    Attribute Description
    dcollection_product_category

    Standard D.Collection store category

    product_ukey

    The unique key of a product

    shop_name

    Store name

    store_id

    Store ID

    shop_no

    Shop (multi-language store) number

    shop_grade

    Popularity of the store

    black : Popularity score 90 or higher
    purple : Popularity score 80 or higher
    green : Popularity score 70 or higher
    orange : Less than popularity score 70

    shop_language

    Language of the store

    ko_KR : Korean
    en_US : English
    zh_CN : Chinese (Simplified)
    zh_TW : Chinese (Traditional)
    ja_JP : Japanese
    vi_VN : Vietnamese

    shop_currency_code

    Payment currency

    KRW : ₩ Korean won
    USD : $ US dollar
    JPY : ¥ Japanese yen
    PHP : ₱ Philippine peso

    product_name

    Product name

    product_no

    Product number

    product_code

    Product code

    product_url

    Product page URL

    product_status_type

    Product status

    N : New
    B : New
    R : Off-season
    U : Preowned
    E : Display model
    F : Refurbished
    S : Scratched

    price

    Product price

    pc_discount_price

    Discounted price (PC order)

    mobile_discount_price

    Discounted price (Mobile order)

    is_pc_discount

    Check whether the product is eligible for PC order discount

    true : Enabled
    false : Disabled

    is_mobile_discount

    Check whether the product is eligible for Mobile order discount

    true : Enabled
    false : Disabled

    pc_discount_rate

    PC order discount rate

    mobile_discount_rate

    Mobile order discount rate

    is_free_shipping

    Check whether the product is eligible for free shipping

    true : Enabled
    false : Disabled

    is_international_shipping

    Whether the product is eligible for international shipping

    true : Enabled
    false : Disabled

    international_shipping_country

    Countries available for shipping

    is_free_gift

    Whether gift is provided

    true : Enabled
    false : Disabled

    is_coupon_discount

    Whether discount coupon is provided

    true : Enabled
    false : Disabled

    product_options

    Product variant

    brand_name

    Brand name

    product_standard_tags

    Product standard tags supported on D.Collection

    product_popular_age

    Popular products by age group

    teenager : Teens
    twenties : Twenties
    thirties : Thirties
    forties : Forties
    etc : Others

    detail_image

    Detailed image URL

    list_image

    List thumbnail URL

    tiny_image

    Sidebar thumbnail image URL

    small_image

    Gallery thumbnail URL

    review_count

    Number of product reviews

    review_score

    Rating of a product review

    hits_count

    Page view count

    expiration_date

    Date

    Validity period of the product

    created_date

    Date

    Product creation date

    updated_date

    Date

    Updated date of the product

    Retrieve a list of products

    GET

    Specification

    Property Description
    SCOPE dcollection.read_product
    Request Limit 40

    Request

    Parameter Description
    dcollection_product_category
    Required

    Standard D.Collection store category

    product_ukey

    Array Max : [100]

    The unique key of a product

    You can search multiple item with ,(comma)

    shop_name

    Array Max : [3]

    Store name

    You can search multiple item with ,(comma)

    store_id

    Store ID

    shop_no

    Array Max : [3]

    Shop (multi-language store) number

    You can search multiple item with ,(comma)

    shop_grade

    Array Max : [4]

    Popularity of the store

    You can search multiple item with ,(comma)

    black : Popularity score 90 or higher
    purple : Popularity score 80 or higher
    green : Popularity score 70 or higher
    orange : Less than popularity score 70

    shop_language

    Language of the store

    ko_KR : Korean
    en_US : English
    zh_CN : Chinese (Simplified)
    zh_TW : Chinese (Traditional)
    ja_JP : Japanese
    vi_VN : Vietnamese

    shop_currency_code

    Payment currency

    KRW : ₩ Korean won
    USD : $ US dollar
    JPY : ¥ Japanese yen
    PHP : ₱ Philippine peso

    product_name

    Array Max : [3]

    Product name

    You can search multiple item with ,(comma)

    product_no

    Array Max : [3]

    Product number

    You can search multiple item with ,(comma)

    product_status_type

    Product status

    N : New
    B : New
    R : Off-season
    U : Preowned
    E : Display model
    F : Refurbished
    S : Scratched

    price_min

    Minimum value of product price range

    price_max

    Maximum value of product price range

    is_pc_discount

    Check whether the product is eligible for PC order discount

    true : Enabled
    false : Disabled

    is_mobile_discount

    Check whether the product is eligible for Mobile order discount

    true : Enabled
    false : Disabled

    pc_discount_price_min

    Minimum search value for discounted price (PC)

    pc_discount_price_max

    Maximum search value for discounted price (PC)

    mobile_discount_price_min

    Minimum search value for discounted price (Mobile)

    mobile_discount_price_max

    Maximum search value for discounted price (Mobile)

    pc_discount_rate_min

    Minimum discount rate value for PC order discount rate

    pc_discount_rate_max

    Maximum discount rate value for PC order discount rate

    mobile_discount_rate_min

    Minimum discount rate value for mobile order discount rate

    mobile_discount_rate_max

    Maximum discount rate value for mobile order discount rate

    is_free_shipping

    Check whether the product is eligible for free shipping

    true : Enabled
    false : Disabled

    is_international_shipping

    Whether the product is eligible for international shipping

    true : Enabled
    false : Disabled

    international_shipping_country

    Countries available for shipping

    is_free_gift

    Whether gift is provided

    true : Enabled
    false : Disabled

    is_coupon_discount

    Whether discount coupon is provided

    true : Enabled
    false : Disabled

    review_count_min

    Minimum value of the number of product reviews

    review_count_max

    Maximum value of the number of product reviews

    review_score_min

    Min : [0]~Max : [5]

    Minimum rating value for product reviews

    review_score_max

    Min : [0]~Max : [5]

    Maximum rating value for product reviews

    brand_name

    Brand name

    product_standard_tags

    Product standard tags supported on D.Collection

    You can search multiple item with ,(comma)

    product_popular_age

    Popular products by age group

    teenager : Teens
    twenties : Twenties
    thirties : Thirties
    forties : Forties
    etc : Others

    created_start_date

    Date

    Start date value of product creation date

    created_end_date

    Date

    End date value of product creation date

    updated_start_date

    Date

    Start date value of product updated date

    updated_end_date

    Date

    End date value of product updated date

    limit

    Min : [1]~Max : [100]

    Maximum number of search results

    DEFAULT 10

    offset

    Min : [0]~Max : [5000]

    Starting location of search results

    DEFAULT 0

    sort

    Value of sort order

    mobile_discount_price : Discounted price (Mobile order)
    pc_discount_price : Discounted price (PC order)
    mobile_discount_rate : Mobile order discount rate
    pc_discount_rate : PC order discount rate
    price : Product price
    created_date : Product creation date
    product_name : Product name
    review_count : Number of product reviews
    review_score : Rating of a product review
    hits_count : Page view count
    popularity_score : Popularity score

    order

    Sort order

    asc : Ascending order
    desc : Descending order

    Retrieve a list of products
    Request Copy
    Response Copy

    Retrieve the number of product items

    GET

    Specification

    Property Description
    SCOPE dcollection.read_product
    Request Limit 40

    Request

    Parameter Description
    dcollection_product_category
    Required

    Standard D.Collection store category

    product_ukey

    Array Max : [100]

    The unique key of a product

    You can search multiple item with ,(comma)

    shop_name

    Array Max : [3]

    Store name

    You can search multiple item with ,(comma)

    store_id

    Store ID

    shop_no

    Array Max : [3]

    Shop (multi-language store) number

    You can search multiple item with ,(comma)

    shop_grade

    Array Max : [4]

    Popularity of the store

    You can search multiple item with ,(comma)

    black : Popularity score 90 or higher
    purple : Popularity score 80 or higher
    green : Popularity score 70 or higher
    orange : Less than popularity score 70

    shop_language

    Language of the store

    ko_KR : Korean
    en_US : English
    zh_CN : Chinese (Simplified)
    zh_TW : Chinese (Traditional)
    ja_JP : Japanese
    vi_VN : Vietnamese

    shop_currency_code

    Payment currency

    KRW : ₩ Korean won
    USD : $ US dollar
    JPY : ¥ Japanese yen
    PHP : ₱ Philippine peso

    product_name

    Array Max : [3]

    Product name

    You can search multiple item with ,(comma)

    product_no

    Array Max : [3]

    Product number

    You can search multiple item with ,(comma)

    product_status_type

    Product status

    N : New
    B : New
    R : Off-season
    U : Preowned
    E : Display model
    F : Refurbished
    S : Scratched

    price_min

    Minimum value of product price range

    price_max

    Maximum value of product price range

    is_pc_discount

    Check whether the product is eligible for PC order discount

    true : Enabled
    false : Disabled

    is_mobile_discount

    Check whether the product is eligible for Mobile order discount

    true : Enabled
    false : Disabled

    pc_discount_price_min

    Minimum search value for discounted price (PC)

    pc_discount_price_max

    Maximum search value for discounted price (PC)

    mobile_discount_price_min

    Maximum search value for discounted price (Mobile)

    mobile_discount_price_max

    Maximum search value for discounted price (Mobile)

    pc_discount_rate_min

    Minimum discount rate value for PC order discount rate

    pc_discount_rate_max

    Maximum discount rate value for PC order discount rate

    mobile_discount_rate_min

    Minimum discount rate value for mobile order discount rate

    mobile_discount_rate_max

    Maximum discount rate value for mobile order discount rate

    is_free_shipping

    Check whether the product is eligible for free shipping

    true : Enabled
    false : Disabled

    is_international_shipping

    Whether the product is eligible for international shipping

    true : Enabled
    false : Disabled

    international_shipping_country

    Countries available for shipping

    is_free_gift

    Whether gift is provided

    true : Enabled
    false : Disabled

    is_coupon_discount

    Whether discount coupon is provided

    true : Enabled
    false : Disabled

    review_count_min

    Minimum value of the number of product reviews

    review_count_max

    Maximum value of the number of product reviews

    review_score_min

    Min : [0]~Max : [5]

    Minimum rating value for product reviews

    review_score_max

    Min : [0]~Max : [5]

    Maximum rating value for product reviews

    brand_name

    Brand name

    product_standard_tags

    Product standard tags supported on D.Collection

    You can search multiple item with ,(comma)

    product_popular_age

    Popular products by age group

    teenager : Teens
    twenties : Twenties
    thirties : Thirties
    forties : Forties
    etc : Others

    created_start_date

    Date

    Start date value of product creation date

    created_end_date

    Date

    End date value of product creation date

    updated_start_date

    Date

    Start date value of product updated date

    updated_end_date

    Date

    End date value of product updated date

    Retrieve the number of product items
    Request Copy
    Response Copy

    Products standardtags

    Products standardtags properties

    Attribute Description
    standard_tag_key

    Standard tag keys

    standard_tag_values

    Standard tag values

    Retrieve a list of product tag properties

    GET

    Specification

    Property Description
    SCOPE dcollection.read_product
    Request Limit 40

    Request

    Parameter Description
    limit

    Min : [1]~Max : [100]

    Maximum number of search results

    DEFAULT 10

    offset

    Min : [0]~Max : [5000]

    Starting location of search results

    DEFAULT 0

    Retrieve a list of product tag properties
    Request Copy
    Response Copy
    Top