NAV Navbar
javascript shell
  • Introduction
  • Cart
  • Categories
  • Products
  • Products cart
  • Products decorationimages
  • Products discountprice
  • Products hits
  • Products options
  • Products variants
  • Products variants inventories
  • Introduction

    Cafe24 API

    Cafe24 Shopping Mall API is an API provided to app store join developers and third-party solution providers to provide services related to shopping malls.

    Cafe24 API is a RESTful architecture that provides OAuth 2.0 based authentication system, a standard HTTP request method, a predictable endpoint URL, and an HTTP code based error message.

    Request/Response Format

    Request Example (search)

    curl -X GET \
      '{endpoint_url}' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json'
    

    Request Example (register/modify)

    curl -X POST \
      '{endpoint_url}' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{ .... }'
    

    Right response example

    {
        "request": {
            "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.

    Front API Intro

    example

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

    Front API

    Front API is suitable for public information(displayed product information) or for customer to get their own information or write at a board. Front API is limited for some informations compare to Admin API.

    API Status Code

    Code Case Solutions
    200 When GET success, PUT success, DELETE success
    201 When POST success
    207 When status is vary as requested multiple objects. Checks the error status of each object and deal with errors according to its status.
    400 Server does not understand request
    1) Wrong Content-Type declaration
    2) Application/type is not json
    Check for the "Content-Type" is application/json when request.
    400 When not use URL Encoded character in API Request URL Check whether API request URL has URL encoded character.
    401 1) When AccessToken is missing
    2) When AccessToken is wrong
    3) When AccessToken is expired
    4) Unrecognizable client
    Check whether the AccessToken is granted and used via valid process.
    401 client_id is missing when using Front API Check whether using valid client_id.
    403 1) AccessToken does not include Scope authority
    2) Access forbidden for Front API
    Check the Scope of API or setting of shopping mall whether you have the authority for request API.
    403 Not a https protocol Check whether request protocol is https.
    403 Shopping mall has not been upgraded to a 'New product' mall Shopping mall has to be upgraded to a 'New product' mall in order to use API.
    403 (Admin API) App has been deleted from the shopping mall. Install again after check whether the App is installed at the shopping mall.
    403 (Front API) App has been deleted from the shopping mall. Install again after check whether the App is installed at the shopping mall.
    404 1) When requested wrong API URL
    2) When cannot found resource
    3) When missing {#id}
    Check the API reference for errors in URL.
    422 When requested value is unprocessible with API reference
    1) Missing necessary parameter
    2) Not same with API reference
    Check the API reference for whether omitted necessary parameter or put a wrong value.
    429 When client requested over than Bucket volume Request later in a while for not exceed maximum request.
    500 Internal server error or unknown error A temporary error has occurred. Please try again.
    503 Server is unavailable Please contact to developer center.
    503 Server is unavailable. Cannot use API right now Please contact to developer center.
    504 Timeout Response timeout due to a temporary error. Please try again later.

    How to use GET API

    Add search criteria

    Example: If you want to search for products with prices over \1,000 within a particular brand
    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
    


    To search multiple sections of a parameter

    Example: When inquiring information of products 11, 12 or 13
    GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13
    


    Searching for Multi-shop information

    Example: Check the products of shopping mall number 2
    GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2
    


    Detailed inquiry and single item check

    Example: How to check product number 128 in detail
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products/128
    
    
    Example: If you want to check the product number 128 using parameters
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?product_no=128
    


    Pagination

    Example: Check 100 products at a time
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?limit=100
    
    
    Example: Check product 201 to product 300
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?limit=100&offset=200
    


    Field Parameters

    Example: When inquiring a product, check only the product name and product number parameters.
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no
    


    Embed parameters

    Example: When inquiring a product, check its option and item data together.
    GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?embed=options,variants
    

    Cafe24 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 criteria

    When inquiring API, you can search search conditions by adding parameters to the endpoint. If you are searching for multiple criteria together, you can add search criteria using the "&" separator.

    You can also search using the "&" separator when searching for ranges such as start date, end date.

    2. Search several conditions in parameter.

    Multiple values can be retrieved simultaneously using commas(,) if supported by the API.

    Search criteria that are added as commas(,) are the OR condition, and all values that match that search condition are scanned.

    3. Multiple shopping mall information check

    If you specify a particular shop_no during API lookup, you can inquire information in the corresponding multI-collar shopping mall. If you don't specify a particular shop_no, check the information in shopping mall 1(default shopping mall).

    4. Check details and key

    Most Entity can inquire in detail by specifying the ID of Entity in the URL.

    You can query only one Entity, but more items are returned than if you are viewing the list.

    5. Pagination

    If you have too many items to query when inquiring a list, all results may not be inquired at once. If you want to inquire more results at once, use the 'limits' parameter to expand the number of queries. If you do not use the 'limits' parameter, you can inquire only the default value of 'limits'.

    The number of queries that can be extended with the limit parameter can be extended only to the maximum value defined for each API. If the limit limit can not be used for all data, the 'offset' parameter can be used. The 'offset' parameter can be used to determine the item to be inquired after starting with the previous product.

    6. Field Parameters

    If you want to query only certain values in the API, you can inquire the values using the field parameters.

    7. Embed Parameters

    Embeded Entity belonging to the product when inquiring an item (e.g. : If you need to inquire the item and inventory together, you can inquire the data of the lower entitywith using the ' embed ' parameter.

    You can use the ' embed ' parameter only in the API that supports it.

    API Limit

    X-Api-Call-Limit : 1/30
    

    Cafe 24 API works with the "Leaky Bucket" algorithm. The Leaky Bucket algorithm has the effect of limiting the number of API requests that are abnormally high for performance purposes, but also allowing the use of routine API requests without restriction.

    Cafe 24 API stacks API requests in the dock. Bucket is limited to API calls when up to "Request Limit" per shopping mall are filled. The Bucket is decreased once per second and can be recalled as a decrease.

    You can avoid the 429 error by checking the X-Api-Call-Limit with the header. You can see how many APIs have been ordered from the shopping mall, and how many Buckets are left.

    Cart

    Cart properties

    Attribute Description
    duplicated_item

    Whether the item code in the cart is a duplicate

    T: Item duplicated
    F: Item not duplicated

    variants

    Item

    Variants information. Number and code of variants to create a cart.

    product_no

    Product number

    System assigned code. This code cannot be duplicated.

    basket_type

    Cart type

    A0000: General
    A0001: Interest-free

    prd_detail_ship_fee

    Whether prepaid shipping fee

    P: Prepayment
    C: Payment after delivery

    Create a cart

    Definition

    POST 'https://{domain}/api/v2/cart'
    
    POST 'https://{mallid}.cafe24api.com/api/v2/cart'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    var data = {
        "request": {
            "duplicated_item_check": "T",
            "product_no": 950,
            "basket_type": "A0000",
            "shipping_type": "A",
            "prefaid_shipping_fee": "P",
            "variants": [
                {
                    "quantity": 1,
                    "variants_code": "P0000BJU000H"
                }
            ]
        }
    } 
    CAFE24API.post('/api/v2/cart', data, function(err, res){
        console.log(res);
    });
    
    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/cart' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "duplicated_item_check": "T",
            "product_no": 950,
            "basket_type": "A0000",
            "shipping_type": "A",
            "prefaid_shipping_fee": "P",
            "variants": [
                {
                    "quantity": 1,
                    "variants_code": "P0000BJU000H"
                }
            ]
        }
    }'
    

    Response example:

    {
        "cart": [
            {
                "duplicated_item": "T",
                "variants": [
                    {
                        "quantity": 1,
                        "variants_code": "P0000BJU000H"
                    },
                    {
                        "quantity": 2,
                        "variants_code": "P0000BJU000M"
                    }
                ],
                "product_no": 950,
                "basket_type": "A0000",
                "shipping_type": "A",
                "prefaid_shipping_fee": "P"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE WRITE_PERSONAL
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    variants

    Item

    Variants information. Number and code of variants to create a cart.

    addtional_products

    Item of the additional composition product

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    basket_type
    Required

    Cart type

    A0000: General
    A0001: Interest-free

    duplicated_item_check
    Required

    Duplicate check of the cart

    T: Duplicate item check
    F: No duplicate item check

    prefaid_shipping_fee
    Required

    Whether prepaid shipping fee

    P: Prepayment
    C: Payment after delivery

    Categories

    Categories Entity

    Categories is a categories that can be used to display or classify products so that shopping mall customers can find them easily. Items must be displayed in one or more product categories for sale. A single item can be displayed in multiple product categories.
    The {#id} of the Categories is "category_no".

    Categories properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    category_no

    Category number

    Unique number of each category. This number cannot be duplicated.

    category_depth

    Min : [1]~Max : [4]

    Category depth

    Shows which depth the category is. There are 4 level of category.

    parent_category_no

    Parent Category Number

    Shows number of upper level of category if the category is among medium scale classification, small scale classification, and micro scale classification.

    When parent_category_no = 1, the category indicates a large scale classification.

    category_name

    Max Length : [50]

    Category name

    Shows the name of the category

    full_category_name

    Full Category Name

    Shows the name of own level and upper level of category if the category is among medium scale classification, small scale classification, and micro scale classification.

    full_category_no

    Full Category Number

    Shows the number of own level and upper level of category if the category is among medium scale classification, small scale classification, and micro scale classification.

    root_category_no

    Top category number

    Shows number of highest level of category of which category belongs.

    display_order

    Display order

    The order of category which is placed by shopping mall operator.

    hash_tags

    Hashtag

    Hashtags of the category.

    ※ This feature is only available when use shopping curation service.

    List all categories

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/categories', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/categories' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "categories": [
            {
                "shop_no": 1,
                "category_no": 27,
                "category_depth": 1,
                "parent_category_no": 1,
                "category_name": "(large scale classification) Bottoms",
                "full_category_name": {
                    "1": "(Main Category) Tops",
                    "2": "(Middle Category) Tees",
                    "3": "(Small Category) Long Sleeve",
                    "4": "(Detailed Category) Cropped"
                },
                "root_category_no": 27,
                "display_order": 0,
                "full_category_no": {
                    "1": "25",
                    "2": "28",
                    "3": "30",
                    "4": "40"
                },
                "hash_tags": [
                    "tag1",
                    "tag2"
                ]
            },
            {
                "shop_no": 1,
                "category_no": 28,
                "category_depth": 1,
                "parent_category_no": 1,
                "category_name": "(large scale classification) Accessories",
                "full_category_no": {
                    "1": "28",
                    "2": null,
                    "3": null,
                    "4": null
                },
                "full_category_name": {
                    "1": "(large scale classification) Accessories",
                    "2": null,
                    "3": null,
                    "4": null
                },
                "display_order": 0,
                "hash_tags": [
                    "tag1",
                    "tag2"
                ]
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_CATEGORY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    Category depth

    Number of depth of category to search.

    category_no

    Category number

    Number of category for search.

    parent_category_no

    Parent Category Number

    Search for the number of parent category which targeting product category belongs.

    If you want to search only large scale classification, search parent_category_no = 1.

    category_name

    Category name

    Search for product category that contain search terms in a category name. (Do not distinguish between capital and lowercase letters)

    limit

    Max : [100]

    Limit

    Set the maximum number of search result.
    Example) input '10' shows only '10' result

    DEFAULT 10

    offset

    Max : [8000]

    Start location of list

    Set the start location of search result.

    Count all categories

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/categories/count', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/categories/count' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    Specification

    Property Description
    SCOPE READ_CATEGORY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    Category depth

    Number of depth of category to search.

    category_no

    Category number

    Number of category for search.

    parent_category_no

    Parent Category Number

    Search for the number of parent category which targeting product category belongs.

    If you want to search only large scale classification, search parent_category_no = 1.

    category_name

    Category name

    Search for product category that contain search terms in a category name. (Do not distinguish between capital and lowercase letters)

    Get a category

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/categories/40', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/categories/40' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "category": {
            "shop_no": 1,
            "category_no": 40,
            "category_depth": 4,
            "parent_category_no": 37,
            "category_name": "(Detailed Category) Cropped",
            "full_category_no": {
                "1": "25",
                "2": "28",
                "3": "30",
                "4": "40"
            },
            "full_category_name": {
                "1": "(Main Category) Tops",
                "2": "(Middle Category) Tees",
                "3": "(Small Category) Long Sleeve",
                "4": "(Detailed Category) Cropped"
            },
            "display_order": 0,
            "hash_tags": [
                "tag1",
                "tag2"
            ]
        }
    }
    

    Specification

    Property Description
    SCOPE READ_CATEGORY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    category_no
    Required

    Category number

    Number of category for search.

    Products

    Products Entity 관계도
    Product' represents goods that sells at shopping mall. Product API can register, search, modify, and delete product. (delete function will be provide.)

    Sub Entity

    Variants
    Hits
    Memos
    SEO

    Products properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    product_no

    Product number

    System assigned code. This code cannot be duplicated.

    product_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    Product code

    System assigned code. This code cannot be duplicated.

    custom_product_code

    Max Length : [40]

    Custom product code

    You may assign this code manually in case of stock management or other reasons.

    product_name

    Max Length : [250]

    Product name

    Name of product. Basic information to search the product and seperate each product. You may input this with HTML.

    eng_product_name

    Max Length : [250]

    English name of product

    English name of product. Necessary when shipping to abroad.

    model_name

    Max Length : [100]

    Model name

    Model name of product

    price

    Product price

    Selling price. Price that before applying coupon or other benefits.

    At the time of product create, all multi-shopping mall's products have the same price. If you want to enter a different price for each multi-shopping mall, you can enter the price differently by modifying the product.

    ※ Price of product when automatically calculated = [ Value of supply + (Value of supply * Rate of margin) + addtional cost ]

    retail_price

    Product retail price

    General price of the product in market. This is used to compare the price of a shopping mall and to emphasize the price of a shopping mall.

    display

    Whether display or not

    User can choose product should be displayed or not. If product is not displayed, customer can't access product thus cannot buy the product.

    T: Display
    F: Do not display

    selling

    Whether selling or not

    User can choose product status should be selling or not. If product is not selling, customer can still access product but cannot buy the product since the product will be displayed as "Sold out".

    If display is FALSE and selling is TRUE, customer can't access product thus cannot buy the product.

    T: Sell
    F: Do not sell

    product_used_month

    Max : [2147483647]

    Months of using the used product

    summary_description

    Max Length : [255]

    Product Summary Description

    Summary description of product. Can Exposed at product display screen. You may input description with HTML.

    product_tag

    Max Length : [200]

    Product tag

    Search tags.

    price_content

    Max Length : [20]

    Alternative phrase of the selling price

    Price will be replaced by this text when sold-out or unavailable for some reasons.

    buy_unit_type

    Type of Purchase unit

    If the purchase unit of the product is set to 1 or more, the setting of whether the purchase unit is the item unit or the product unit

    P: Based on product
    O: Based on quantity

    buy_unit

    Minimum unit per purchase

    Minimum unit per purchase.

    Ex ) If product's minimum unit per purchase is 3, customer can only buy the product as multiple number of 3.

    order_quantity_limit_type

    Criteria of order quantity restriction

    If you limit the order quantity of the product, you can set whether the limit should be based on item or product unit.

    P: Based on product
    O: Based on quantity

    minimum_quantity

    Max : [2147483647]

    Minimum quantity per purchase

    Minimum quantity per purchase. Customer cannot buy the product below the minimum quantity.

    maximum_quantity

    Max : [2147483647]

    Maximum quantity per purchase

    Maximum quantity per purchase. Customer cannot buy the product above the maximum quantity.

    If the maximum order quantity is "no limit", it is displayed as "0".

    mileage_amount

    Mileage setting

    Mileage accumulation percentage setting. You may diverse percentage by payment method.



    Setting individually - You may set the percentage regardless of payment method or set the percentage differently by payment method.

    [mileage_amount] => 10.00%



    Setting individually - You may set the percentage differently by payment method.



    [cash] => 0%

    adult_certification

    Adult certification

    Whether the product requires adult certification. Customer needs to be authenticated to purchase products that require adult certification.

    detail_image

    Detail image

    Detail image' showing on the product detail page.

    list_image

    List image

    List image' showing on the product category page, main page, product search result page.

    tiny_image

    Tiny image

    Small list image' showing on the recently viewed page.

    small_image

    Reduced image

    Reduced image' showing on the bottom side of the product detail page.

    has_option

    Whether the option is used

    Shows product either has an option or not. Product with option offer various choices such as size, color, and flavors.

    T: use option
    F: do not use option

    option_type

    Type of option

    Shows type of option when "has_option" is TRUE.

    ● combination all-selected : Shows combination of 'all options' in 'a single selecbox'(button or radio button).
    ● combination separate-selected : Customer can choose 'options' at 'each selectbox'(button or radio button) and make 'a combination of option' based on 'the name of option'.
    ● linked with product : The way how to show type of option is similar to 'combination types' but this type can choose both 'necessary option' and 'selectable option'. This type can make 'unlimited combinations of options'.
    ● independently selectable : Customer can select 'each indepentent options'. 'Each option' will be generated as 'each variant'.

    C: Combination integration option
    S: Combination separation option
    E: Product connection
    F: Independent selection

    manufacturer_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    Manufacturer code

    Code uses for designate specific manufacturer. This code generated automatically when register a new manufacturer.

    Set as default code(M0000000) if doesn't input.

    trend_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    Trend code

    Code uses for designate specific trend. This code generated automatically when register a new trend.

    Set as default code(T0000000) if doesn't input.

    brand_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    Brand code

    Code uses for designate specific brand. This code generated automatically when register a new brand.

    Set as default code(B0000000) if doesn't input.

    made_date

    Date of manufacture

    Date of manufacture of the product.

    expiration_date

    Array Max : [2]

    Expiration date

    Indicate the expiration date of intangible goods such as gift certificates or tickets or type goods such as food or cosmetics.

    origin_classification

    Origin classification

    Distinguish the origin of a product.

    F: domestic
    T: abroad
    E: other

    origin_place_no

    Origin place no

    List the origin number List all Origin by API
    If origin_classification is F (domestic), it is possible to enter origin only if foreign (foreign) is "F".
    If origin_classification is T (overseas), it is possible to enter origin only if foreign (foreign) is "T".

    origin_place_value

    Max Length : [30]

    Extra information for code of origin

    You may add additional information if 'origin_place_code' is 1800.

    icon_show_period

    Period for showing icon

    Period for showing icon.

    icon

    Array Max : [5]

    List of icon

    Icon displays at the product. This icon can use a purpose of emphsize selling.

    product_material

    Material of product

    The material of the item. You should enter each material and percentage of composing material if the product is has a multiple material.

    list_icon

    Recommend / sold out / new icon expose flag

    Either showing recommend / sold out / new icon will be exposed or not.

    ※ sold out icon

    ● Showing that the product is sold out
    ● Displays out of stock if mall using stock management function

    ※ recommend / new icon

    ● If the item is displayed in the area of category or the recommendation product on the main page or new product, shows the icon as it set.

    select_one_by_option

    Whether select only one by option

    When using 'independently selectable' option type and this set as TRUE, customer can select only 1 item per option.
    If this set as FALSE, customer can select multiple items per option.

    ※ This Flag Is Only Available When Using 'Independently Selectable' Option Type.

    T: Use
    F: Do not use

    approve_status

    Approve request result

    N: New request for approval
    E: request for approval updated
    C: Approval complete
    R: Approval rejected
    I: Approval in progress
    Empty Value: Never requested

    sold_out

    Whether sold out or stock is available

    T: Out-of-stock
    F: No out-of-stock

    discountprice

    Product discount sale price Entity


    Can search with using embed parameter.

    decorationimages

    Decoration Image Entity


    Can search with using embed parameter.

    variants

    Variants


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.

    memos

    Memos


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.

    hits

    Product hits entity


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.

    seo

    Product Seo Entity


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.

    category

    Category number

    Category of the product. Product is marked with this category.

    It can be displayed only in detail inquiry.

    description

    Detail description of product

    Detail description of product. You may input description with HTML.

    It can be displayed only in detail inquiry.

    mobile_description

    Mobile version of product description

    Mobile version of product description. Replace product description to the mobile version when customer access a mobile shopping mall.

    It can be displayed only in detail inquiry.

    additional_image

    Array Max : [20]

    Additional image

    'Additional image' showing on the bottom side of the product detail page. Displayed at similar location with 'Reduced image' and can see 'Additional image' when mouse over at PC version or swipe at mobile version.

    It can be displayed only in detail inquiry.

    payment_info

    Payment info

    Guidance for payment method. You may input this with HTML.

    It can be displayed only in detail inquiry.

    shipping_info

    Shipping info

    Guidance for shipping method. You may input this with HTML.

    It can be displayed only in detail inquiry.

    exchange_info

    Exchange info

    Guidance for exchange and return method. You may input this with HTML.

    It can be displayed only in detail inquiry.

    service_info

    Service info

    Guidance for service warranty information. You may input this with HTML.

    It can be displayed only in detail inquiry.

    product_tax_type_text

    Vat tax info

    Displays text set at VAT text setting menu.

    It can be displayed only in detail inquiry.

    set_product_type

    Product bundle type

    It can be displayed only in detail inquiry.

    C: integral type. S: assembled type

    simple_description

    Simple Product Description

    Simple description of product. Can Exposed at product display screen. You may input description with HTML.

    It can be displayed only in detail inquiry.

    tags

    Product Tag Entity


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.

    options

    Product Option Entity


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.

    shipping_method

    Shipping method

    Following is the method when 'individual_delivery' is TRUE

    It can be displayed only in detail inquiry.

    01: regular delivery
    02: fast service (document only)
    03: regular mail (document only)
    04: delivery in person
    05: delivery in person with bike or truck (within several hours)
    06: other
    07: cargo delivery
    08: pickup at a store
    09: delivery does not necessary

    prepaid_shipping_fee

    Whether prepaid shipping fee

    It can be displayed only in detail inquiry.

    C: Pay on delivery
    P: Prepaid
    B: Select Prepaid/Pay on delivery

    shipping_period

    Shipping period

    (When using 'Shipping charge individually') Average transit time for make a delivery.

    It can be displayed only in detail inquiry.

    shipping_scope

    Shipping information

    Shows whether can only deliver domestically or can deliver to overseas too.

    Cannot set the type when 'Shipping charge individually' is FALSE.

    It can be displayed only in detail inquiry.

    A: Domestic only
    C: Export only
    B: Can deliver both inland and overseas

    shipping_area

    Max Length : [255]

    Shipping area

    (When using 'Shipping charge individually') Available shipping region.

    It can be displayed only in detail inquiry.

    shipping_fee_type

    Shipping charge

    (When using 'Shipping charge individually') Type of shipping charge.

    It can be displayed only in detail inquiry.

    T: Free shipping R: Fixed rate M: Charge according to purchase amount D: Use different shipping charges per different purchase amount W: Use different shipping charges by product weight C: Use different shipping charges by quantity N: Use different shipping charges per different quantity

    shipping_rates

    Charge shipping by section

    If shipping_fee_type is R or N, you can set the shipping cost by defining shipping_fee in the array.

    If shipping_fee_type is M, D, W, C, you can set the shipping interval by defining the following in the array.
    shipping_rates_min: Shipping interval start
    shipping_rates_max: Shipping interval end
    shipping_fee: shipping

    It can be displayed only in detail inquiry.

    clearance_category_code

    Type : [A-Z0-9]
    Length Min : [8]~Max : [8]

    Clearance category code

    It can be displayed only in detail inquiry.

    origin_place_code

    Code of origin

    Code of origin

    It can be displayed only in detail inquiry.

    additional_information

    Additional information list

    You may add additional information other than basic information.

    It can be displayed only in detail inquiry.

    main

    Whether displays at main or not

    Displays main display number when display products at main page such as "recommend product" or "new".

    It can be displayed only in detail inquiry.

    relational_product

    Related product

    Related or similar product of selected product. Registered related product display the bottom of the product detail page.

    It can be displayed only in detail inquiry.

    List all products

    Definition

    GET 'https://{domain}/api/v2/products'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "products": [
            {
                "shop_no": 1,
                "product_no": 24,
                "product_code": "P000000X",
                "custom_product_code": "",
                "product_name": "iPhone X",
                "eng_product_name": "iPhone Ten",
                "model_name": "A1865",
                "price": "1000.00",
                "retail_price": "0.00",
                "display": "T",
                "selling": "F",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "price_content": null,
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "adult_certification": "F",
                "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
                "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
                "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
                "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
                "has_option": "F",
                "option_type": "T",
                "manufacturer_code": "M0000000",
                "trend_code": "T0000000",
                "brand_code": "B0000000",
                "made_date": "",
                "expiration_date": {
                    "start_date": "20170908",
                    "end_date": "20170914"
                },
                "origin_classification": "F",
                "origin_place_no": 1798,
                "origin_place_value": "",
                "icon_show_period": {
                    "start_date": "2017-10-30 09:00:00",
                    "end_date": "2017-11-02 16:00:00"
                },
                "icon": [
                    "icon_01_01",
                    "icon_02_01"
                ],
                "product_material": "",
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "",
                "sold_out": "F"
            },
            {
                "shop_no": 1,
                "product_no": 23,
                "product_code": "P000000W",
                "custom_product_code": "",
                "product_name": "iPhone X",
                "eng_product_name": "iPhone Ten",
                "model_name": "A1865",
                "price": 1000,
                "retail_price": 0,
                "display": "T",
                "selling": "F",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "price_content": null,
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "adult_certification": "F",
                "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
                "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
                "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
                "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
                "has_option": "F",
                "option_type": "T",
                "manufacturer_code": "M0000000",
                "trend_code": "T0000000",
                "brand_code": "B0000000",
                "made_date": "",
                "expiration_date": {
                    "start_date": "20170908",
                    "end_date": "20170914"
                },
                "origin_classification": "F",
                "origin_place_no": 1798,
                "origin_place_value": "",
                "icon_show_period": {
                    "start_date": "2017-10-30 09:00:00",
                    "end_date": "2017-11-02 16:00:00"
                },
                "icon": [
                    "icon_01_01",
                    "icon_02_01"
                ],
                "product_material": "",
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "C",
                "sold_out": "F"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    discountprice
    embed

    Product discount sale price Entity


    Can search with using embed parameter.

    decorationimages
    embed

    Decoration Image Entity


    Can search with using embed parameter.

    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no

    Product number

    Number of a product.

    You can search multiple item with ,(comma)

    display

    Whether display or not

    Search for products that displayed or not.

    selling

    Whether selling or not

    Search for products that sell or not.

    product_name

    Product name

    Search for products that contain keyword in a product name (Case Insensitive)

    You can search multiple item with ,(comma)

    product_code

    Product code

    Search for products that include keyword in the product code. (Case Sensitive)

    You can search multiple item with ,(comma)

    brand_code

    Brand code

    Search for products with matching brand codes.

    You can search multiple item with ,(comma)

    manufacturer_code

    Manufacturer code

    Search for products with matching manufacturer code.

    You can search multiple item with ,(comma)

    supplier_code

    Supplier code

    Search for products with matching supplier code.

    You can search multiple item with ,(comma)

    trend_code

    Trend code

    Search for products with matching trend code.

    You can search multiple item with ,(comma)

    product_tag

    Product tag

    Search for products that include keyword in the product search term or tag. (Case Insensitive)

    You can search multiple item with ,(comma)

    custom_product_code

    Custom product code

    Search for products that include keyword in the custom product code. (Case Sensitive)

    You can search multiple item with ,(comma)

    price_min

    Minimum price

    Search for products that price is over a certain range.

    price_max

    Maximum price

    Search for products that price is below a certain range.

    retail_price_min

    Minimum retail price

    Search for products that retail price is over a certain range.

    retail_price_max

    Maximim retail price

    Search for products that retail price is below a certain range.

    supply_price_min

    Minimum supply price

    Search for products that supply price is over a certain range.

    supply_price_max

    Maximum supply price

    Search for products that supply price is below a certain range.

    created_start_date

    timezone

    Registered date start

    Search for items that product creation date is after a certain date.
    Must use with 'created start date' simultaneously.
    Search only on specific date if search start and end dates are the same.

    created_end_date

    timezone

    Registered date end

    Search for items that product creation date is before a certain date.
    Must use with 'created end date' simultaneously.
    Search only on specific date if search start and end dates are the same.

    updated_start_date

    timezone

    Updated date start

    Search for items that product updated date is after a certain date.
    Must use with 'updated start date' simultaneously.
    Search only on specific date if search start and end dates are the same.

    updated_end_date

    timezone

    Updated date end

    Search for items that product updated date is before a certain date.
    Must use with 'updated end date' simultaneously.
    Search only on specific date if search start and end dates are the same.

    category

    Category number

    Search for items that displayed at a certain category.

    eng_product_name

    English name of product

    Search for products that contain keyword in a english product name (Case Insensitive)

    You can search multiple item with ,(comma)

    supply_product_name

    Supplier product name

    Search for products that include keyword in the supply product name. (Case Insensitive)

    You can search multiple item with ,(comma)

    model_name

    Model name

    Search for products that include keyword in the model name. (Case Insensitive)

    You can search multiple item with ,(comma)

    product_condition

    Product condition

    Search for products of specific condition.

    You can search multiple item with ,(comma)

    origin_place_value

    Origin

    Extra information for code of origin. You may add additional information if 'origin_place_code' is 1800.

    You can search multiple item with ,(comma)

    stock_quantity_max

    Maximum stock search

    Search for items that product stock is below a certain value.

    stock_quantity_min

    Minimum stock search

    Search for variants that product stock is above a certain value.

    If a product has several items, it searches if any of the items meet the condition.

    stock_safety_max

    Search of maximum safety inventory quantity

    stock_safety_min

    Search of minimum safety inventory quantity

    product_weight

    Weight of product

    Search for items that weigh certain kilograms.

    You can search multiple item with ,(comma)

    classification_code

    Classification code

    You can search multiple item with ,(comma)

    use_inventory

    Whether use inventory or not

    Whether use inventory management or not at the variants of the products.

    T: Use
    F: Do not use

    category_unapplied

    Unapplied Category

    Search for products that category unapplied.

    T : Search for products that category unapplied

    include_sub_category

    include sub category

    Search for products that include sub category.

    T: Included

    additional_information_key

    additional information key

    Search for products that has specific additional information. In order to search, key and value is necessary.

    additional_information_value

    additional information value

    Search for products that has specific additional information. In order to search, key and value is necessary.

    approve_status

    Approval Status

    N: Approval request (New product) status
    E: Approval request (Product modification) status
    C: Approved status
    R: Rejected status
    I: Checking status

    since_product_no

    Min : [1]
    Max : [2147483647]

    Search after a certain product number

    Search products from after a certain product number. Can search regardless of offset.

    ※ Cannot use below parameter when using this search condition.

    product_no
    sort
    order
    offset

    sort

    Sort order

    created_date: Created Date
    updated_date: Updated Date
    product_name: Product Name

    order

    Order by

    asc: Ascending
    desc: Descending

    offset

    Max : [5000]

    Start location of list

    Set the start location of search result.

    limit

    Max : [100]

    Limit

    Set the maximum number of search result.
    Example) input '10' shows only '10' result

    DEFAULT 10

    Count all products

    Definition

    GET 'https://{domain}/api/v2/products/count'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/count'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/count', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/count' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 2
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no

    Product number

    Number of a product.

    You can search multiple item with ,(comma)

    display

    Whether display or not

    Search for products that displayed or not.

    selling

    Whether selling or not

    Search for products that sell or not.

    product_name

    Product name

    Search for products that contain keyword in a product name (Case Insensitive)

    You can search multiple item with ,(comma)

    product_code

    Product code

    System assigned code. This code cannot be duplicated.

    You can search multiple item with ,(comma)

    brand_code

    Brand code

    Search for products with matching brand codes.

    You can search multiple item with ,(comma)

    manufacturer_code

    Manufacturer code

    Search for products with matching manufacturer code.

    You can search multiple item with ,(comma)

    supplier_code

    Supplier code

    Search for products with matching supplier code.

    You can search multiple item with ,(comma)

    trend_code

    Trend code

    Search for products with matching trend code.

    You can search multiple item with ,(comma)

    product_tag

    Product tag

    Search for products that include keyword in the product search term or tag. (Case Insensitive)

    You can search multiple item with ,(comma)

    custom_product_code

    Custom product code

    Search for products that include keyword in the custom product code. (Case Sensitive)

    You can search multiple item with ,(comma)

    price_min

    Minimum price

    Search for products that price is over a certain range.

    price_max

    Maximum price

    Search for products that price is below a certain range.

    retail_price_min

    Minimum retail price

    Search for products that retail price is over a certain range.

    retail_price_max

    Maximim retail price

    Search for products that retail price is below a certain range.

    supply_price_min

    Minimum supply price

    Search for products that supply price is over a certain range.

    supply_price_max

    Maximum supply price

    Search for products that supply price is below a certain range.

    created_start_date

    timezone

    Registered date start

    Search for items that product creation date is after a certain date.
    Must use with 'created start date' simultaneously.
    Search only on specific date if search start and end dates are the same.

    created_end_date

    timezone

    Registered date end

    Search for items that product creation date is before a certain date.
    Must use with 'created end date' simultaneously.
    Search only on specific date if search start and end dates are the same.

    updated_start_date

    timezone

    Updated date start

    Search for items that product updated date is after a certain date.
    Must use with 'updated start date' simultaneously.
    Search only on specific date if search start and end dates are the same.

    updated_end_date

    timezone

    Updated date end

    Search for items that product updated date is before a certain date.
    Must use with 'updated end date' simultaneously.
    Search only on specific date if search start and end dates are the same.

    category

    Category number

    Search for items that displayed at a certain category.

    eng_product_name

    English name of product

    Search for products that contain keyword in a english product name (Case Insensitive)

    You can search multiple item with ,(comma)

    supply_product_name

    Supplier product name

    Search for products that include keyword in the supply product name. (Case Insensitive)

    You can search multiple item with ,(comma)

    model_name

    Model name

    Search for products that include keyword in the model name. (Case Insensitive)

    You can search multiple item with ,(comma)

    product_condition

    Product condition

    Search for products of specific condition.

    You can search multiple item with ,(comma)

    origin_place_value

    Origin

    Extra information for code of origin. You may add additional information if 'origin_place_code' is 1800.

    You can search multiple item with ,(comma)

    stock_quantity_max

    Maximum stock search

    Search for items that product stock is below a certain value.

    stock_quantity_min

    Minimum stock search

    Search for variants that product stock is above a certain value.

    If a product has several items, it searches if any of the items meet the condition.

    stock_safety_max

    Search of maximum safety inventory quantity

    stock_safety_min

    Search of minimum safety inventory quantity

    product_weight

    Weight of product

    Search for items that weigh certain kilograms.

    You can search multiple item with ,(comma)

    classification_code

    Classification code

    Search for products with matching custom classification code.

    You can search multiple item with ,(comma)

    use_inventory

    Whether use inventory or not

    Whether use inventory management or not at the variants of the products.

    T: Use
    F: Do not use

    category_unapplied

    Unapplied Category

    Search for products that category unapplied.

    T : Search for products that category unapplied

    include_sub_category

    include sub category

    Search for products that include sub category.

    T: Included

    additional_information_key

    additional information key

    Search for products that has specific additional information. In order to search, key and value is necessary.

    additional_information_value

    additional information value

    Search for products that has specific additional information. In order to search, key and value is necessary.

    approve_status

    Approval Status

    N: Approval request (New product) status
    E: Approval request (Product modification) status
    C: Approved status
    R: Rejected status
    I: Checking status

    since_product_no

    Min : [1]
    Max : [2147483647]

    Search after a certain product number

    Search products from after a certain product number. Can search regardless of offset.

    ※ Cannot use below parameter when using this search condition.

    product_no
    sort
    order
    offset

    Get a product

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/20', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/20' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -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",
            "model_name": "A1865",
            "price": "1000.00",
            "retail_price": "0.00",
            "display": "T",
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "additional_image": [
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg"
                },
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/e1ab68969d69287a828438c7684b14c4.jpg"
                }
            ],
            "payment_info": "Sample payment info. You have to Pay.",
            "shipping_info": "Sample shipping info. You have to ship.",
            "exchange_info": "Sample exchange info. You have to exchange.",
            "service_info": "Sample service info. You have to service.",
            "meta_title": "",
            "meta_author": "",
            "meta_description": "",
            "meta_keywords": "",
            "meta_alt": "",
            "search_engine_exposure": "T",
            "product_tax_type_text": null,
            "set_product_type": null,
            "selling": "F",
            "product_used_month": 2,
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "product_tag": "edu,test,sample",
            "tags": {
                "tag": [
                    "edu",
                    "test",
                    "sample"
                ]
            },
            "price_content": null,
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "mileage_amount": null,
            "adult_certification": "F",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
            "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
            "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
            "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
            "has_option": "F",
            "option_type": "T",
            "manufacturer_code": "M0000000",
            "trend_code": "T0000000",
            "brand_code": "B0000000",
            "made_date": "",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "origin_classification": "F",
            "origin_place_no": 1798,
            "origin_place_value": "",
            "icon_show_period": {
                "start_date": "2017-10-30 09:00:00",
                "end_date": "2017-11-02 16:00:00"
            },
            "icon": null,
            "product_material": "",
            "shipping_method": "01",
            "prepaid_shipping_fee": "B",
            "shipping_period": {
                "minimum": 3,
                "maximum": 7
            },
            "shipping_scope": "A",
            "shipping_area": "All around World",
            "shipping_fee_type": "W",
            "shipping_rates": [
                {
                    "shipping_rates_min": "0.00",
                    "shipping_rates_max": "1.00",
                    "shipping_fee": "100.00"
                },
                {
                    "shipping_rates_min": "1.00",
                    "shipping_rates_max": "2.00",
                    "shipping_fee": "200.00"
                }
            ],
            "clearance_category_code": "ACAB0000",
            "list_icon": {
                "soldout_icon": true,
                "recommend_icon": true,
                "new_icon": true
            },
            "additional_information": [
                {
                    "key": "custom_option1",
                    "name": "gift option",
                    "value": "Yes"
                }
            ],
            "main": [
                3,
                2
            ],
            "relational_product": [
                {
                    "product_no": 17,
                    "interrelated": "T"
                },
                {
                    "product_no": 19,
                    "interrelated": "F"
                }
            ],
            "select_one_by_option": "F",
            "approve_status": "C",
            "sold_out": "F"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no
    Required

    Product number

    Number of a product.

    variants
    embed

    Variants


    Can search with using embed parameter.

    memos
    embed

    Memos


    Can search with using embed parameter.

    hits
    embed

    Product hits entity


    Can search with using embed parameter.

    seo
    embed

    Product Seo Entity


    Can search with using embed parameter.

    tags
    embed

    Product Tag Entity


    Can search with using embed parameter.

    options
    embed

    Product Option Entity


    Can search with using embed parameter.

    discountprice
    embed

    Product discount sale price Entity


    Can search with using embed parameter.

    decorationimages
    embed

    Decoration Image Entity


    Can search with using embed parameter.

    Products cart

    Merchandise cart is information that allows you to check how many items the customer has put in the cart by item. You can check how many items are included in your shopping cart with the Cart API.

    Products cart properties

    Count all products cart

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/11/cart/count', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/11/cart/count' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 7
    }
    

    Specification

    Property Description
    SCOPE READ_PERSONAL
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Products decorationimages

    Products decorationimages properties

    Attribute Description
    use_show_date

    whether use show date or not

    T: Use
    F: Do not use

    show_start_date

    timezone

    start date of show_date

    show_end_date

    timezone

    end date of show_date

    image_list

    list of decoration image

    List all products decoration images

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/{#id}/decorationimages', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/{#id}/decorationimages' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "decorationimage": {
            "use_show_date": "T",
            "show_start_date": "2017-10-30T09:00:00+09:00",
            "show_end_date": "2017-11-02T16:00:00+09:00",
            "image_list": [
                {
                    "code": "image_custom_4",
                    "path": "\/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"
                }
            ]
        }
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Products discountprice

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC discount price

    mobile_discount_price

    Mobile discount price

    List all products discountprice

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/24/discountprice', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/24/discountprice' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "discountprice": {
            "pc_discount_price": "7000.00",
            "mobile_discount_price": "6000.00"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    Products hits

    Product Views (Hits) is a measure of how much your products are viewed by your shopping mall customers. You can see how many products your customers are viewing most by checking product views.
    Product views can only be used in the Products subset as a embedded Entity.

    Products hits properties

    Count all products hits

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/7/hits/count', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/7/hits/count' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "count": 3
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Products options

    Products options properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    has_option

    Whether the option is used

    T: Use
    F: Do not use

    option_type

    Type of option

    Shows type of option when "has_option" is TRUE.

    ● combination : make 'a combination of option' based on 'the name of option'.
    ● linked with product : The way how to show type of option is similar to 'combination types' but this type can choose both 'necessary option' and 'selectable option'. This type can make 'unlimited combinations of options'.
    ● independently selectable : Customer can select 'each indepentent options'. 'Each option' will be generated as 'each variant'.

    T: Combination
    E: linked with product
    F: independently selectable

    option_list_type

    Option list type

    If you use the combined option, show the type of the combined option

    * combination all-selected : Shows combination of 'all options' in 'a single selecbox'(button or radio button).
    * combination separate-selected : Customer can choose 'options' at 'each selectbox'(button or radio button) and make 'a combination of option' based on 'the name of option'.

    If you use "linked with product" option or "independently selectable" option, S(separate selected) is used by default.

    C: Integrated type
    S: Separated type

    option

    Option

    If you use the linked with product option, show the option preset name.

    select_one_by_option

    Whether select only one by option

    When using 'independently selectable' option type and this set as TRUE, customer can select only 1 item per option.
    If this set as FALSE, customer can select multiple items per option.

    ※ This Flag Is Only Available When Using 'Independently Selectable' Option Type.

    T: Use
    F: Do not use

    use_additional_option

    Whether use additional option

    T: Use
    F: Do not use

    additional_option

    Additional option

    use_attached_file_option

    Whether use attached file option

    T: Use
    F: Do not use

    attached_file_option

    Attached file option

    List all products options

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/7/options', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/7/options' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "options": {
            "shop_no": 1,
            "product_no": 7,
            "has_option": "T",
            "option_type": "E",
            "option_display_type": "S",
            "option": [
                {
                    "option_code": "O000000A",
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
                            "option_color": "#000000",
                            "option_text": "Black"
                        },
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_831549.gif",
                            "option_color": "#007543",
                            "option_text": "Red"
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                },
                {
                    "option_code": "O000000B",
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
                            "option_color": "#000000",
                            "option_text": "Small"
                        },
                        {
                            "option_image_file": "\/web\/product\/option_button\/201804\/temp_shop1_931549.gif",
                            "option_color": "#007543",
                            "option_text": "Large"
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                }
            ],
            "select_one_by_option": "F",
            "use_additional_option": "T",
            "additional_option": [
                {
                    "additional_option_name": "Pattern",
                    "required_additional_option": "T",
                    "additional_option_text_length": 20
                },
                {
                    "additional_option_name": "Custom Option",
                    "required_additional_option": "F",
                    "additional_option_text_length": 10
                }
            ],
            "use_attached_file_option": "T",
            "attached_file_option": {
                "option_name": "Pattern Images",
                "required": "T",
                "size_limit": 3
            }
        }
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Products variants

    Products Variants is the basic unit of goods sold in the shopping mall. Shopping malls usually sell the same items but different sizes or different colors to provide customers with different options.
    The {#id} of the Products Variants is "variants_code".
    Products Variants has the following Entity as a embedded Entity:

    Inventories

    Products variants properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    variant_code

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    Variant code

    System assigned code. This code cannot be duplicated.

    option

    Option

    Option of variants. This indicates which option the variants consists of. The variants is able to purchase when customer choose the option.

    display

    Whether display or not

    Whether display the variants or not. If this set as TRUE, customer may choose the variants at product detail page or product list page. If this set as FALSE, variants will not be displayed thus cannot buy the variants.

    T: Display
    F: Do not display

    selling

    Whether selling or not

    Whether display the variants or not. If this set as TRUE, customer may choose the variants at product detail page or product list page. If this set as FALSE, variants will not be displayed thus cannot buy the variants.

    T: Sell
    F: Do not sell

    additional_amount

    Additional price

    Additional price for purchase the variants.

    inventories

    Inventories

    Inventory Entity of variants.
    Can search with using embed parameter.

    List all products variants

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/20/variants', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/20/variants' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variants": [
            {
                "shop_no": 1,
                "item_code": "P000000R000C",
                "option": [
                    {
                        "name": "Color",
                        "value": "Blue"
                    },
                    {
                        "name": "Size",
                        "value": "Small"
                    }
                ],
                "display": "T",
                "selling": "T",
                "additional_amount": "0.00"
            },
            {
                "shop_no": 1,
                "item_code": "P000000R000D",
                "option": [
                    {
                        "name": "Color",
                        "value": "Red"
                    },
                    {
                        "name": "Size",
                        "value": "Small"
                    }
                ],
                "display": "T",
                "selling": "T",
                "additional_amount": "0.00"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Get a products variant

    Definition

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

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/20/variants/P000000R000C', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/20/variants/P000000R000C' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "variant": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "option": [
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "display": "T",
            "selling": "T",
            "additional_amount": "0.00"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    variant_code
    Required

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    Variant code

    inventories
    embed

    Inventories


    Can search with using embed parameter.

    Products variants inventories

    Products Variants Inventories refers to the quantity of eligible items available for sale. Products Variants Inventories is available for each variant. If the variants sold out over than Products Variants Inventories, the product becomes out of stock status.

    Products variants inventories properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    variant_code

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    Variant code

    System assigned code. This code cannot be duplicated.

    quantity

    Available inventory

    Available inventory to sale. The number will deduct when order or payment made. Available inventory counted to shows 'Sold out' or not.

    List all products variants inventory

    Definition

    GET 'https://{domain}/api/v2/products/{#id}/variants/{#id}/inventories'
    
    GET 'https://{mallid}.cafe24api.com/api/v2/products/{#id}/variants/{#id}/inventories'
    

    Request example:

    CAFE24API.init('BrIfqEKoP.......'); //App Key
    
    CAFE24API.get('/api/v2/products/20/variants/P000000R000C/inventories', function(err, res){
        console.log(res);
    });
    
    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/products/20/variants/P000000R000C/inventories' \
      -H 'X-Cafe24-App-Key: {client_id}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "inventory": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "quantity": 0
        }
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    variant_code
    Required

    Type : [A-Z0-9]
    Length Min : [12]~Max : [12]

    Variant code

    Variants code for search sales volume.