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

    Admin API Intro

    example

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

    Admin API

    The Admin API is suitable for the shopping mall administrator to query, create, modify, and delete information in the shopping mall. The Admin API can get almost every information of entity and available only after pass Oauth 2.0 authentication.

    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.

    Authentication

    Cafe24 API uses OAuth2.0 authentication method. Only clients with OAuth2.0 authentication are allowed to use the API. If OAuth2.0 authentication has been passed, a complicated string called the Access Token is returned. Cafe24 API calls API only when this access token is specified in header.

    Get Authentication Code

    When requesting a token to be issued, the code used can not be reused and expires one minute after the code is issued.

    Example (request)

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

    Example (response)

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

    To receive an access token, you must request a cotton access code. The access code is used if the client is in the form of a Web application.

    Get Access Token

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

    Example (request)

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

    Example (response)

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

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

    refresh_token : This token is used to reissue after the approach token expires.

    Get Access Token using refresh token

    The approach token is unavilable after two hours after issued. After the approach token has expired, it must be reissued before the resource server can be accessed. If you have already received the approach token, you can re-issue it using refresh_token.

    The refresh token is valid for two weeks. If you request it before refresh token is finished, it is returned with the updated access token. You can not use the old refresh token after it has expired.

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

    Example (request)

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

    Example (response)

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

    access_token : Used as access token when clients access resource servers.

    refresh_token : This token is used to reissue after the approach token expires.

    Appstore orders

    With the App Store Order Creation API, You can create an App Store order to charge the shopping mall operator for the amount needed to pay.

    Appstore orders properties

    Attribute Description
    order_id

    Order ID

    App store's order ID

    order_name

    Order Name

    The name of the order in the App store order. The order can be specified when creating the order, and it must be what the user can know about the contents of the payment.

    order_amount

    Order Amount

    The amount of the order you requested for payment when creating an App store order

    return_url

    Return Url

    The page that redirects a user automatically to after payment.

    automatic_payment

    Max Length : [1]

    Automatic payments status

    T: Use
    F: Do not use

    created_date

    timezone

    Order Created Date

    It can be displayed only in detail inquiry.

    confirmation_url

    Payment URL

    The page URL that users automatically go to make a payment

    Get an appstore order

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    order_id
    Required

    Order ID

    App store order number to get

    Create an appstore order

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    order_name
    Required

    Max Length : [100]

    Order Name

    The name of the order in the App store order. The order can be specified when creating the order, and it must be what the user can know about the contents of the payment.

    order_amount
    Required

    Order Amount

    Enter the amount of the order you want to user pay

    return_url
    Required

    Max Length : [250]

    Return URL

    The page that redirects a user automatically to after payment. Enter the Thank you page URL.

    automatic_payment

    Max Length : [1]

    Automatic payments status

    T: Use
    F: Do not use

    DEFAULT F

    Appstore payments

    Once you've paid for your App Store order, you can view your payment by viewing your App Store billing.

    Appstore payments properties

    Attribute Description
    order_id

    Order ID

    App store's order ID

    title

    Payment name

    The name of the order in the App store order. The order can be specified when creating the order, and it must be what the user can know about the contents of the payment.

    approval_no

    Approval Number

    Payment approval number

    payment_gateway_name

    Payment Gateway Number

    payment_method

    Payment Method

    payment_amount

    Payment Amount

    currency

    Currency

    locale_code

    Billing Country

    pay_date

    timezone

    Payment Approval Date

    List all appstore payments

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    order_id

    Order ID

    App store order number to get

    You can search multiple item with ,(comma)

    start_date
    Required

    Date
    timezone

    Search Start Date

    Search for paid orders after the date

    end_date
    Required

    Date
    timezone

    Search End Date

    Search for orders that have been paid before the date

    limit

    Max : [50]

    Limit

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

    DEFAULT 20

    offset

    Max : [10000]

    Start location of list

    Set the start location of search result.

    Count all appstore payments

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 2
    }
    

    Specification

    Property Description
    SCOPE READ_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    order_id

    Order ID

    App store order number to get

    You can search multiple item with ,(comma)

    start_date
    Required

    Date
    timezone

    Search Start Date

    Search for paid orders after the date

    end_date
    Required

    Date
    timezone

    Search End Date

    Search for orders that have been paid before the date

    Brands

    Brands is an information that you enter into a brand section in a product's "production information". A brand is one of the sales categories that distinguish products in the shopping mall. Products must have one brand (using "own brand" when not specified)
    Brands {#id} is "brand_code".

    Brands properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    brand_code

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

    Brand code

    brand_name

    Max Length : [50]

    Brand name

    use_brand

    Whether to use a brand or not

    Whether use brand or not.

    T: Use
    F: Do not use

    created_date

    Created date

    product_count

    Product count

    Number of products.

    List all brands

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    brand_code

    Brand code

    You can search multiple item with ,(comma)

    brand_name

    Brand name

    You can search multiple item with ,(comma)

    use_brand

    Whether to use a brand or not

    T: Use
    F: Do not use

    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 brands

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 2
    }
    

    Specification

    Property Description
    SCOPE READ_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    brand_code

    Brand code

    You can search multiple item with ,(comma)

    brand_name

    Brand name

    You can search multiple item with ,(comma)

    use_brand

    Whether to use a brand or not

    T: Use
    F: Do not use

    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

    display_type

    Display setting

    Setting for shows the product category displays at among which PC mall, Mobile mall, or both mall.

    A: PC + Mobile
    P: PC
    M: Mobile
    F: Not Used

    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.

    use_main

    Main classification display status

    Whether the product category is displayed at the main page or not. If this is "TRUE", product category will displayed on the main page regardless of depth of product category.

    T: Displayed
    F: Not displayed

    use_display

    Display status

    Whether the product category is displayed or not. The product category will not accessible when 'FALSE'.

    The setting can not be set for each multi-shopping mall and is applied to all shopping malls.

    T: Displayed
    F: Not displayed

    display_order

    Display order

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

    soldout_product_display

    Sold-out product display status

    Whether to display out-of-stock products at the top or bottom of the category.
    You can get what product is sold out, Using "List all products" API's sold_out parameter.

    B: Arranged out-of-stock items to the back
    F: Arranged out-of-stock items to the front
    N: N/A

    sub_category_product_display

    Sub-category Product display status

    Whether to display products that are displayed in the sub-category

    T: Display
    F: Do not display

    hashtag_product_display

    Hashtag based product display

    Whether use or not use hashtag based product display.

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

    T: Display
    F: Do not display

    hash_tags

    Hashtag

    Hashtags of the category.

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

    product_display_scope

    Category display scope

    Whether to sort products by category or sort by area

    If the value is "all", you can set category order by these parameters.

    product_display_type
    product_display_key
    product_display_sort
    product_display_period

    If the value is "by area", you can set category by area by these parameters.

    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period

    A: All
    G: By section

    product_display_type

    Category display method

    If category display scope is "all", category display method.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    normal_product_display_type

    Category display method

    If category display scope is "By area", category display method in normal product area.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    normal_product_display_key

    Category display key

    If category display scope is "By area" and category display method is "auto align" or "auto align + manual align", the sort key of category display in normal product area.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    normal_product_display_sort

    Category display order

    Whether category display in normal product area is ascending or descending.

    D: Descending order
    A: Ascending order

    normal_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    recommend_product_display_type

    Category display method

    If category display scope is "By area", category display method by recommend product area.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    recommend_product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    recommend_product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    recommend_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    new_product_display_type

    Category display method

    If category display scope is "all", category display method.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    new_product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    new_product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    new_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    List all categories

    Definition

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

    Request example:

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

    Response example:

    {
        "categories": [
            {
                "shop_no": 1,
                "category_no": 27,
                "category_depth": 1,
                "parent_category_no": 1,
                "category_name": "(large scale classification) Bottoms",
                "display_type": "A",
                "full_category_name": {
                    "1": "(Main Category) Tops",
                    "2": "(Middle Category) Tees",
                    "3": "(Small Category) Long Sleeve",
                    "4": "(Detailed Category) Cropped"
                },
                "root_category_no": 27,
                "use_main": "F",
                "use_display": "T",
                "display_order": 0,
                "full_category_no": {
                    "1": "25",
                    "2": "28",
                    "3": "30",
                    "4": "40"
                },
                "soldout_product_display": "B",
                "sub_category_product_display": "T",
                "hashtag_product_display": "T",
                "hash_tags": [
                    "tag1",
                    "tag2"
                ],
                "product_display_scope": "A",
                "product_display_type": "U",
                "product_display_key": "A",
                "product_display_sort": "D",
                "product_display_period": "W",
                "normal_product_display_type": null,
                "normal_product_display_key": null,
                "normal_product_display_sort": null,
                "normal_product_display_period": null,
                "recommend_product_display_type": null,
                "recommend_product_display_key": null,
                "recommend_product_display_sort": null,
                "recommend_product_display_period": null,
                "new_product_display_type": null,
                "new_product_display_key": null,
                "new_product_display_sort": null,
                "new_product_display_period": null
            },
            {
                "shop_no": 1,
                "category_no": 28,
                "category_depth": 1,
                "parent_category_no": 1,
                "category_name": "(large scale classification) Accessories",
                "display_type": "A",
                "full_category_no": {
                    "1": "28",
                    "2": null,
                    "3": null,
                    "4": null
                },
                "full_category_name": {
                    "1": "(large scale classification) Accessories",
                    "2": null,
                    "3": null,
                    "4": null
                },
                "use_main": "F",
                "use_display": "T",
                "display_order": 0,
                "soldout_product_display": "B",
                "sub_category_product_display": "T",
                "hashtag_product_display": "T",
                "hash_tags": [
                    "tag1",
                    "tag2"
                ],
                "product_display_scope": "A",
                "product_display_type": "U",
                "product_display_key": "A",
                "product_display_sort": "D",
                "product_display_period": "W",
                "normal_product_display_type": null,
                "normal_product_display_key": null,
                "normal_product_display_sort": null,
                "normal_product_display_period": null,
                "recommend_product_display_type": null,
                "recommend_product_display_key": null,
                "recommend_product_display_sort": null,
                "recommend_product_display_period": null,
                "new_product_display_type": null,
                "new_product_display_key": null,
                "new_product_display_sort": null,
                "new_product_display_period": null
            }
        ]
    }
    

    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://{mallid}.cafe24api.com/api/v2/admin/categories/count'
    

    Request example:

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

    Response example:

    {
        "count": 3
    }
    

    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://{mallid}.cafe24api.com/api/v2/admin/categories/{#id}'
    

    Request example:

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

    Response example:

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

    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.

    Create a category

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_CATEGORY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    parent_category_no

    Parent Category Number

    If you want to register a category in a specific category, you can register it by entering the parent category number.

    category_name
    Required

    Max Length : [50]

    Category name

    The name of the category

    display_type

    Display setting

    Setting for shows the product category displays at among which PC mall, Mobile mall, or both mall.

    A: PC + Mobile
    P: PC
    M: Mobile
    F: Not Used

    use_main

    Main classification display status

    Whether the product category is displayed at the main page or not. If this is "TRUE", product category will displayed on the main page regardless of depth of product category.

    T: Displayed
    F: Not displayed

    use_display

    Display status

    Whether the product category is displayed or not. The product category will not accessible when 'FALSE'.

    The setting can not be set for each multi-shopping mall and is applied to all shopping malls.

    T: Displayed
    F: Not displayed

    soldout_product_display

    Sold-out product display status

    Whether to display out-of-stock products at the top or bottom of the category.

    B: Arranged out-of-stock items to the back
    F: Arranged out-of-stock items to the front
    N: N/A

    sub_category_product_display

    Sub-category Product display status

    Whether to display products that are displayed in the sub-category

    T: Display
    F: Do not display

    hashtag_product_display

    Hashtag based product display

    Whether use or not use hashtag based product display.

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

    T: Display
    F: Do not display

    hash_tags

    Hashtag

    Hashtags of the category.

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

    product_display_scope

    Category display scope

    Whether to sort products by category or sort by area

    If the value is "all", must enter these fields.

    product_display_type
    product_display_key
    product_display_sort
    product_display_period (Required only if key is S or C)

    If the value is "by area", must enter these fields.
    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period (Required only if key is S or C)
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period (Required only if key is S or C)
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period (Required only if key is S or C)

    A: All
    G: By section

    product_display_type

    Category display method

    If category display scope is "all", category display method.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    normal_product_display_type

    Category display method

    If category display scope is "By area", category display method in normal product area.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    normal_product_display_key

    Category display key

    If category display scope is "By area" and category display method is "auto align" or "auto align + manual align", the sort key of category display in normal product area.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    normal_product_display_sort

    Category display order

    Whether category display in normal product area is ascending or descending.

    D: Descending order
    A: Ascending order

    normal_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    recommend_product_display_type

    Category display method

    If category display scope is "By area", category display method by recommend product area.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    recommend_product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    recommend_product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    recommend_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    new_product_display_type

    Category display method

    If category display scope is "all", category display method.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    new_product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    new_product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    new_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    Update a category

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_CATEGORY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    category_no
    Required

    Category number

    category_name

    Max Length : [50]

    Category name

    The name of the category

    display_type

    Display setting

    Setting for shows the product category displays at among which PC mall, Mobile mall, or both mall.

    A: PC + Mobile
    P: PC
    M: Mobile
    F: Not Used

    use_main

    Main classification display status

    Whether the product category is displayed at the main page or not. If this is "TRUE", product category will displayed on the main page regardless of depth of product category.

    T: Displayed
    F: Not displayed

    use_display

    Display status

    Whether the product category is displayed or not. The product category will not accessible when 'FALSE'.

    The setting can not be set for each multi-shopping mall and is applied to all shopping malls.

    T: Displayed
    F: Not displayed

    soldout_product_display

    Sold-out product display status

    Whether to display out-of-stock products at the top or bottom of the category.

    B: Arranged out-of-stock items to the back
    F: Arranged out-of-stock items to the front
    N: N/A

    sub_category_product_display

    Sub-category Product display status

    Whether to display products that are displayed in the sub-category

    T: Display
    F: Do not display

    hashtag_product_display

    Hashtag based product display

    Whether use or not use hashtag based product display.

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

    T: Display
    F: Do not display

    hash_tags

    Hashtag

    Hashtags of the category.

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

    product_display_scope

    Category display scope

    Whether to sort products by category or sort by area

    If the value is "all", must enter these fields.

    product_display_type
    product_display_key
    product_display_sort
    product_display_period (Required only if key is S or C)

    If the value is "by area", must enter these fields.
    normal_product_display_type
    normal_product_display_key
    normal_product_display_sort
    normal_product_display_period (Required only if key is S or C)
    recommend_product_display_type
    recommend_product_display_key
    recommend_product_display_sort
    recommend_product_display_period (Required only if key is S or C)
    new_product_display_type
    new_product_display_key
    new_product_display_sort
    new_product_display_period (Required only if key is S or C)

    A: All
    G: By section

    product_display_type

    Category display method

    If category display scope is "all", category display method.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    normal_product_display_type

    Category display method

    If category display scope is "By area", category display method in normal product area.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    normal_product_display_key

    Category display key

    If category display scope is "By area" and category display method is "auto align" or "auto align + manual align", the sort key of category display in normal product area.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    normal_product_display_sort

    Category display order

    Whether category display in normal product area is ascending or descending.

    D: Descending order
    A: Ascending order

    normal_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    recommend_product_display_type

    Category display method

    If category display scope is "By area", category display method by recommend product area.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    recommend_product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    recommend_product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    recommend_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    new_product_display_type

    Category display method

    If category display scope is "all", category display method.

    A: Automatic arrangement
    U: Customized
    M: Automatic arrangement + Customized

    new_product_display_key

    Category display key

    If category display scope is "all" and category display method is "auto align" or "auto align + manual align", the sort key of category display.

    A: Recently added product
    R: Recently registered product
    U: Recently modified product
    N: Alphabetically arranged product names
    P: Product with a high selling price
    S: Product with high sales volume
    C: Most viewed product
    L: Most liked product

    new_product_display_sort

    Category display order

    Whether category display is ascending or descending.

    D: Descending order
    A: Ascending order

    new_product_display_period

    Category display period

    If category display key is "By sales (S)" or "By hits count(C)", the period for category display.

    W: Total period
    1D: 1 day
    3D: 3 days
    7D: 7 days
    15D: 15 days
    1M: 1 month
    3M: 3 months
    6M: 6 months

    Delete a category

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_CATEGORY
    Request Limit 30

    Request

    Parameter Description
    category_no
    Required

    Category number

    Classifications

    Classifications is an information that you enter in your product's "production information" for your own classification. Self-classification is one of the sales categories that distinguish the product, and the product must have one self-classification (using "default self-classification" when not specified)

    Classifications properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    classification_code

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

    Classification code

    classification_name

    Max Length : [200]

    Classification name

    classification_description

    Max Length : [300]

    Classification description

    use_classification

    Use classification

    created_date

    timezone

    Created date

    product_count

    Product count

    Number of products.

    List all classifications

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    classification_code

    Classification code

    You can search multiple item with ,(comma)

    classification_name

    Classification name

    You can search multiple item with ,(comma)

    use_classification

    Use classification

    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 classifications

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 3
    }
    

    Specification

    Property Description
    SCOPE READ_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    classification_code

    Classification code

    You can search multiple item with ,(comma)

    classification_name

    Classification name

    You can search multiple item with ,(comma)

    use_classification

    Use classification

    Coupons

    Coupons Entity
    Coupons is the benefits that can be issued to members of a shopping mall to discount the price of a product or to get a discount on shipping fees. Coupons can be used to promote (promote) shopping malls and can be issued to members in various forms.
    Coupons {#id} is "coupon_no".

    Coupons properties

    Attribute Description
    shop_no

    Shop Number

    DEFAULT 1

    coupon_no

    Coupon number

    Number of coupon

    coupon_type

    Coupon type

    Type of coupon. There are Online and Offline serial type of coupon.

    O: Online coupon
    S: Off-line serial coupon

    coupon_name

    Coupon name

    Name of coupon

    coupon_description

    Coupon description

    Description of coupon

    created_date

    timezone

    Created date

    Date of coupon created

    deleted

    Whether coupon is deleted

    Whether coupon is deleted or not

    T: Deleted
    F: Not deleted

    is_stopped_issued_coupon

    Whether coupon is deleted and deactivated

    Whether coupon is deleted and deactivated completely. Issued coupon is no longer available when coupon completely deactivated and deleted.

    T: completely deleted and deactivated
    F: not completely deleted and deactivated

    pause_begin_datetime

    timezone

    Coupon pause start date

    Coupon issue pause began date. Coupon cannot be issued while pause.

    pause_end_datetime

    timezone

    Coupon pause end date

    Coupon issue pause end date. Coupon cannot be issued while pause.

    benefit_text

    Display the coupon benefits details

    Displays detailed information of coupon's benefits.

    benefit_type

    Benefit type

    Type of benefit. Each type has different benefit.

    A: Discount amount
    B: Discount rate
    C: Accumulated amount
    D: Accrual rate
    E: Basic shipping fee discount (All discounts)
    I: Basic shipping fee discount (Discount rate)
    H: Basic shipping fee discount (Discount amount)
    F: Instant accumulation

    benefit_price

    Benefit amount

    Amount of discount benefit

    benefit_percentage

    Benefit ratio

    Amount of percentage of discount benefit

    benefit_percentage_round_unit

    Benefit percentage cutoff unit

    Cutoff unit for the amount of discount benefit

    benefit_percentage_max_price

    Maximum benefit ratio

    Maximum price amount for discount benefit

    include_regional_shipping_rate

    Regional shipping flag

    Whether include regional shipping price when discount shipping price.

    T: Include category by region
    F: Not include category by region

    DEFAULT F

    include_foreign_delivery

    Shipping abroad flag

    Whether include overseas shipping for coupon benefit.

    T: Overseas delivery included
    F: Overseas delivery not included

    DEFAULT F

    coupon_direct_url

    Direct access url

    URL for direct access to the coupon.

    issue_type

    Issue type

    Issue type of coupon.

    M: Issuance to target person
    A: Conditional automatic issuance
    D: Issuance through customer download

    issue_sub_type

    Detailed issue type

    Detailed issue type of coupon.

    M: For members
    C: For real-time users
    J: Joining the membership
    D: Upon delivery
    A: Anniversary (Birthday)
    I: Installing a module (program)
    P: Writing a product review
    O: Upon order completion
    Q: When the purchase quantity is met
    F: First-time customer
    N: For non-purchasing members for a certain period

    issue_member_join

    Welcome flag

    Whether the coupon issued when signed up.

    T: issued
    F: not issued

    DEFAULT F

    issue_member_join_recommend

    Recommended id

    Whether the coupon issued to recommended ID.

    T: issued
    F: not issued

    DEFAULT F

    issue_member_join_type

    Welcome customer flag

    Whether the customer is type for receive welcome coupon.

    A: SMS acceptance and e-mail acceptance
    O: SMS acceptance or e-mail acceptance
    S: SMS acceptance
    E: E-mail acceptance

    issue_order_amount_type

    Discount standard amount

    Standard for discount of coupon.

    O: Based on the purchase amount
    S: Based on the actual payment

    issue_order_start_date

    timezone

    Order start date

    Order start date for issue the coupon.

    issue_order_end_date

    timezone

    Order end date

    Order end date for issue the coupon.

    issue_order_amount_limit

    Limit type for order amount

    You may set the limit for the order amount for issuing coupon.

    U: unlimited
    L: minimum amount
    S: price zone

    issue_order_amount_min

    Minimum order amount

    You may set the minimum amount for the order amount for issuing coupon.

    issue_order_amount_max

    Maximum order amount

    You may set the maximum amount for the order amount for issuing coupon.

    issue_order_path

    Available order path

    Available order path for coupon use.

    W: Only for Web shopping mall
    M: Only for mobile shopping mall
    P: Only for Plus app

    issue_order_type

    Issue unit

    Issue unit for coupon.

    O: Coupon issued by order form
    P: Coupon issued by product

    issue_order_available_product

    Issue object product

    Object product for issuing coupon.

    U: No restrictions
    I: Apply the selected product.
    E: Exclude the selected product.

    issue_order_available_category

    Issue object category

    Object category for issuing coupon.

    U: No restrictions
    I: Apply the selected product.
    E: Exclude the selected product.

    issue_anniversary_type

    Issue Anniversary Type

    Object anniversary type for issuing coupon.

    B: Birthday
    W: Wedding anniversary

    issue_anniversary_pre_issue_day

    Preissuance dates for anniversary to issue

    Date for how long anniversary coupon can be issued in advance.

    issue_module_type

    Module type

    Module type for the type of module install condition coupon.

    S: Shortcut
    B: Favorite
    L: Live linkOn

    issue_review_count

    Number of product reviews to issue

    Necessary number of reviews for issuing coupon.

    issue_review_has_image

    Whether to include product review images to issue

    Whether the review must includes image when issuing coupon.

    T: Included
    F: Not included

    DEFAULT F

    issue_quantity_min

    Minimum purchase quantity for coupon issuance

    You may set the minimum volume for the order for issuing coupon.

    issue_quntity_type

    Discount standard volume

    Volume standard for discount of coupon.

    P: Based on product quantity
    O: Based on order quantity

    issue_max_count

    Maximum Issue Count

    Maximum issue availbale quantity of coupon.

    issue_max_count_by_user

    Maximum Issue Count per user

    Maximum issue availablequ antity for the same customer

    issue_count_per_once

    Each coupon issuance quantity (for one time)

    Quantity for each coupon issue.

    issued_count

    Issued count

    Count the number of the specific coupon issued.

    issue_member_group_no

    Issue Member Group Number

    Number of group object for issuing coupon.

    issue_member_group_name

    Issue Member Group Name

    Name of group object for issuing coupon.

    issue_no_purchase_period

    Non-purchase condition period

    Period of non-purchase when coupon's condition is non-purchase for certain term.

    issue_reserved

    Issue reservation

    Whether use the function of coupon issue reservation. The reserved coupon will be issued automatically.

    T: use automatic issue reservation
    F: do not use automatic issue reservation

    DEFAULT F

    issue_reserved_date

    timezone

    Reservation time

    Reservation time for reserved coupon issue.

    available_date

    Available date

    Available date for coupons useage.

    available_period_type

    Available date type

    Type of available date for coupons useage.

    F: General period
    R: Based on coupon issuance date
    M: Use by the end of the month

    available_begin_datetime

    timezone

    Available start date

    Start date of coupon usage.

    available_end_datetime

    timezone

    Available end date

    End date of coupon usage.

    available_site

    Available Site

    Inflow type for use coupon.

    W: Only for Web shopping mall
    M: Only for mobile shopping mall
    P: Only for Plus app

    available_scope

    Available scope

    Coupon available scope. 'Product coupon' applicable single product. 'Order coupon' applicable order.

    P: Product coupon
    O: Order coupon

    available_day_from_issued

    Available day

    Days for how long the coupon is available.

    available_price_type

    Available price type

    Criteria of coupon availble price amount. Multiply the number of product and price is the coupon criteria if the coupon is applicable to product price. Total amount including shipping and other discount will be the coupon criteria if the coupon is applicable to order price.

    U: No restrictions
    O: Based on the order amount
    P: Based on the product cost

    available_min_price

    Available price type

    Coupon avilable purchase amount.

    available_amount_type

    Available Amount Type

    Amount of price to apply coupon. Whether apply coupon discount before other discount(such as membership or product discount) or after discount of other discount method.

    E: Payment before discount (except coupon) is applied
    I: Payment after discount (except coupon) is applied

    available_payment_method

    Available payment method

    Coupon applicable payment method.

    R: Bank transfer
    E: Virtual account
    C: Card settlement
    A: Real-time account transfer
    H: Phone billing
    M: Reserve
    K: Kpay
    P: Pay Now
    N: Payco
    O: Kakao Pay

    available_product

    Applicable product

    You may choose coupon applicable product. Either exclude specific product from the applicable list or include every product in the list.

    U: No restrictions
    I: Apply the selected product.
    E: Exclude the selected product.

    available_category

    Applicable category

    You may choose coupon applicable category. Either exclude specific category from the applicable list or include every category in the list.

    U: No restrictions
    I: Apply the selected category.
    E: Exclude the selected category.

    available_coupon_count_by_order

    Max number per order

    Maximum available number of coupon per single order.

    serial_generate_method

    Serial generate method

    Serial coupon generate method.

    A: automatically
    M: manually register
    E: excel upload

    coupon_image_type

    Coupon image type

    Image type of coupon.

    B: Use the default image.
    C: Directly upload an image.

    coupon_image_path

    Coupon image path

    URL of coupon image.

    show_product_detail

    Whether to expose the product details page

    Whether displays coupon at product detail page.

    T: Product details exposed
    F: Product details not exposed

    DEFAULT F

    use_notification_when_login

    Whether to use the coupon issuance alarm during the log-in

    Whether use coupon issue notification when customer login.

    T: use notification
    F: do not use notification

    DEFAULT F

    send_sms_for_issue

    Whether to send SMS of coupon issuance

    Whether send a coupon issue information by SMS.

    T: send SMS
    F: do not send SMS

    DEFAULT F

    send_email_for_issue

    Whether to send the coupon issuance information via e-mail

    Whether send a coupon issue information by E-mail.

    T: send Email
    F: do not send Email

    DEFAULT F

    List all coupons

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_PROMOTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    coupon_no

    Coupon number

    Number of coupon

    coupon_type

    Coupon type

    Type of coupon. There are Online and Offline serial type of coupon.

    O: Online coupon
    S: Off-line serial coupon

    coupon_name

    Coupon name

    Name of coupon

    benefit_type

    Benefit type

    Type of benefit. Each type has different benefit.

    You can search multiple item with ,(comma)

    A: Discount amount
    B: Discount rate
    C: Accumulated amount
    D: Accrual rate
    E: Basic shipping fee discount (All discounts)
    I: Basic shipping fee discount (Discount rate)
    H: Basic shipping fee discount (Discount amount)
    F: Instant accumulation

    issue_type

    Issue type

    Issue type of coupon.

    You can search multiple item with ,(comma)

    M: Issuance to target person
    A: Conditional automatic issuance
    D: Issuance through customer download

    issue_sub_type

    Detailed issue type

    Sub type of coupon issue.

    M: For members
    C: For real-time users
    J: Joining the membership
    D: Upon delivery
    A: Anniversary (Birthday)
    I: Installing a module (program)
    P: Writing a product review
    O: Upon order completion
    Q: When the purchase quantity is met
    F: First-time customer
    N: For non-purchasing members for a certain period

    issued_flag

    Issued flag

    Whether the coupon has been issued before or not.

    T: has been issued before
    F: has not been issued before

    created_start_date

    Date
    timezone

    Search Start Date

    Search for coupons that created after certain date.

    created_end_date

    Date
    timezone

    Search End Date

    Search for coupons that created before certain date.

    deleted

    Whether coupon is deleted

    Whether coupon is deleted or not

    You can search multiple item with ,(comma)

    T: deleted
    F: not deleted

    DEFAULT F

    pause_begin_date

    Date
    timezone

    Coupon pause start date

    Search start date, for coupons that based on coupon pause date.

    pause_end_date

    Date
    timezone

    Coupon pause end date

    Search end date, for coupons that based on coupon pause date.

    issue_order_path

    Available order path

    Available order path for coupon use.

    W: PC
    M: Mobile
    P: Plus app

    issue_order_type

    Issue unit

    Whether coupon issued based on product or order.

    P: Product coupon
    O: Order coupon

    issue_reserved

    Issue reservation

    Whether use the function of coupon issue reservation. The reserved coupon will be issued automatically.

    T: use automatic issue reservation
    F: do not use automatic issue reservation

    available_period_type

    Available date type

    Type of available date for coupons useage.

    You can search multiple item with ,(comma)

    F: General period
    R: Based on coupon issuance date
    M: Use by the end of the month

    available_datetime

    Date
    timezone

    Available datetime

    Search for coupon that issue available at certain date.

    Valid only if available_period_type is F

    available_site

    Available Site

    Available order path for coupon use.

    W: Only for Web shopping mall
    M: Only for mobile shopping mall
    P: Only for Plus app

    available_scope

    Available scope

    Coupon available scope. 'Product coupon' applicable single product. 'Order coupon' applicable order.

    P: Product coupon
    O: Order coupon

    available_price_type

    Available price type

    Criteria of coupon availble price amount. Whether the coupon is applicable to product price or order pricr or no restriction.

    U: No restrictions
    O: Based on the order amount
    P: Based on the product cost

    limit

    Max : [500]

    Limit

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

    DEFAULT 100

    offset

    Max : [8000]

    Start location of list

    Set the start location of search result.

    Count all coupons

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 24
    }
    

    Specification

    Property Description
    SCOPE READ_PROMOTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    coupon_no

    Coupon number

    Number of coupon

    coupon_type

    Coupon type

    Type of coupon. There are Online and Offline serial type of coupon.

    O: Online coupon
    S: Off-line serial coupon

    coupon_name

    Coupon name

    Name of coupon

    benefit_type

    Benefit type

    Type of benefit. Each type has different benefit.

    You can search multiple item with ,(comma)

    A: Discount amount
    B: Discount rate
    C: Accumulated amount
    D: Accrual rate
    E: Basic shipping fee discount (All discounts)
    I: Basic shipping fee discount (Discount rate)
    H: Basic shipping fee discount (Discount amount)
    F: Instant accumulation

    issue_type

    Issue type

    Issue type of coupon.

    You can search multiple item with ,(comma)

    M: Issuance to target person
    A: Conditional automatic issuance
    D: Issuance through customer download

    issue_sub_type

    Detailed issue type

    Detailed issue type of coupon.

    M: For members
    C: For real-time users
    J: Joining the membership
    D: Upon delivery
    A: Anniversary (Birthday)
    I: Installing a module (program)
    P: Writing a product review
    O: Upon order completion
    Q: When the purchase quantity is met
    F: First-time customer
    N: For non-purchasing members for a certain period

    issued_flag

    Issued flag

    Whether the coupon has been issued before or not.

    T: has been issued before
    F: has not been issued before

    created_start_date

    Date
    timezone

    Search Start Date

    Search for coupons that created after certain date.

    created_end_date

    Date
    timezone

    Search End Date

    Search for coupons that created before certain date.

    deleted

    Whether coupon is deleted

    Whether coupon is deleted or not

    You can search multiple item with ,(comma)

    T: deleted
    F: not deleted

    DEFAULT F

    pause_begin_date

    Date
    timezone

    Coupon pause start date

    Coupon issue pause began date. Coupon cannot be issued while pause.

    pause_end_date

    Date
    timezone

    Coupon pause end date

    Coupon issue pause end date. Coupon cannot be issued while pause.

    issue_order_path

    Available order path

    Available order path for coupon use.

    W: PC
    M: Mobile
    P: Plus app

    issue_order_type

    Issue unit

    Whether coupon issued based on product or order.

    P: Product coupon
    O: Order coupon

    issue_reserved

    Issue reservation

    Whether use the function of coupon issue reservation. The reserved coupon will be issued automatically.

    T: use automatic issue reservation
    F: do not use automatic issue reservation

    available_period_type

    Available date type

    Type of available date for coupons useage.

    You can search multiple item with ,(comma)

    F: General period
    R: Based on coupon issuance date
    M: Use by the end of the month

    available_datetime

    Date
    timezone

    Available datetime

    Search for coupon that issue available at certain date.

    Valid only if available_period_type is F

    available_site

    Available Site

    Available order path for coupon use.

    W: Only for Web shopping mall
    M: Only for mobile shopping mall
    P: Only for Plus app

    available_scope

    Available scope

    Coupon available scope. 'Product coupon' applicable single product. 'Order coupon' applicable order.

    P: Product coupon
    O: Order coupon

    available_price_type

    Available price type

    Criteria of coupon availble price amount. Whether the coupon is applicable to product price or order pricr or no restriction.

    U: No restrictions
    O: Based on the order amount
    P: Based on the product cost

    Coupons issue

    Coupon issue history(Issue) is a list of the issued coupon to the member. If you register your membership information and coupon number in the coupon issue history, you can issue a coupon to the member.

    Coupons issue properties

    Attribute Description
    shop_no

    Shop Number

    count

    Coupons Issued count

    Number of customer who successfully issued coupon.

    Create a coupons issue

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_PROMOTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    coupon_no
    Required

    Coupon number

    Number of coupon

    issued_member_scope
    Required

    Issue member scope

    You may set specific category of coustomer to issue coupon.
    When you issue coupon to certain customer group(G), group_no is required.
    Whe you issue coupons to certain member(M), member_id is required.

    A: for every customer
    G: certain customer group
    M: certain customer

    group_no

    Group number

    Customer group number.

    member_id

    Member id

    ID of customer

    send_sms_for_issue
    Required

    Whether to send SMS of coupon issuance

    Whether send a coupon issue information by SMS.

    T: send SMS
    F: do not send SMS

    allow_duplication

    Allow duplication

    Whether coupon can be issued duplicate.

    T: Issued
    F: Not issued
    S: Not issued (Whether to use
    no additional verification during the use period)

    DEFAULT F

    single_issue_per_once

    Single issue per once

    Whether coupon issued only one per one request.

    T: Issued one by one
    F: Issued as many as the simultaneous issuance quantity setting

    DEFAULT T

    issue_count_per_once

    Min : [2]
    Max : [10]

    Issue count per once

    The number of coupon if coupon issues with multiple quantity per one request.

    DEFAULT 2

    issued_place_type

    Issued Place Type

    Where coupon issed from.

    W: Web
    M: Mobile
    P: Plus app

    issued_by_action_type

    Issued action type

    Whether when coupon issued either installed app or accepted app push.

    INSTALLATION: Coupon issuance when installing the app
    ACCEPTING_PUSH: Coupon issuance when receiving the app push is On

    issued_by_event_type

    Issued By Event Type

    Type of conditional benefit for coupon issue

    C: Attendance check event
    U: Member information modification event
    B: Banner profit share program
    R: Roulette game (CMC) team
    Z: Plus app installation (Plus app)
    Y: Push notification ON (Plus app)
    X: Plus app order (Plus app)
    M: Remind Me order
    W: Remind Me reward
    V: Integrated membership
    L: Lifetime member conversion event

    request_admin_id

    Request admin id

    ID of coupon issuer

    Currency

    Currency properties

    Attribute Description
    exchange_rate

    Exchange rate

    standard_currency_code

    Standard currency code

    The currency code used in the shopping mall of the shopping mall. Standard currency refers to the currency commonly used in countries where a shopping mall operator belongs.

    standard_currency_symbol

    Standard currency symbol

    The currency symbol used in the shopping mall of the shopping mall. Standard currency refers to the currency commonly used in countries where a shopping mall operator belongs.

    shop_currency_code

    Shopping mall currency code

    shop_currency_symbol

    Shopping mall currency symbol

    Get currency setting

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_STORE
    Request Limit 30

    Customergroup

    Customer Group Entity

    CustomerGroups is a concept that groups members into groups to manage them. A member must belong to one membership level and will be classified as a "regular member" if they have not been rated separately. Depending on your membership level, you may be able to offer benefits or send messages only to specific membership levels.

    The {#id} of the membership level (CustomerGroups) is "group_no".

    Customergroup properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    group_no

    Group number

    Number of member group.

    group_name

    Group Name

    Name of member group.

    group_description

    Group Description

    Description of member group.

    benefits_paymethod

    Benefit payment condition

    Payment condition for receive benefit.

    A: All payments
    B: Cash payment (Bank transfer)
    C: All payments except cash payment

    buy_benefits

    Buy benefits

    Benefits when purchased product.

    F: No benefits
    D: Purchase amount discount
    M: Reserve provision
    P: Both discount/credit applied

    ship_benefits

    Shipping benefits

    Shipping benefits. Shipping may be either free shipping or paid shpping

    T: Set free shipping fee
    F: Set charged shipping fee

    product_availability

    Product Availability

    You may set discount for product. Either apply product discount or apply membership discount or apply both discount.

    P: Apply only discount by product
    M: Apply only discount by member level
    A: Apply discount by product and member level

    discount_information

    Discount information

    Set a discount based on purchase amount. Discount can be set according to minimum payment amount.

    mileage_information

    Mileage information

    Set a mileage based on purchase amount. Mileage can be set according to minimum payment amount.

    mobile_discount_information

    Mobile discount information

    Set a mobile discount based on purchase amount. Mobile discount can be set according to minimum payment amount.

    mobile_mileage_information

    Mobile mileage information

    Set a mobile mileage based on purchase amount. Mobile mileage can be set according to minimum payment amount.

    List all customergroup

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    group_no

    Group number

    System assigned member group number. This code cannot be duplicated.

    You can search multiple item with ,(comma)

    group_name

    Max Length : [20]

    Group Name

    Name of member group.

    You can search multiple item with ,(comma)

    Count all customergroup

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 1
    }
    

    Specification

    Property Description
    SCOPE READ_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    group_no

    Group number

    System assigned member group number. This code cannot be duplicated.

    You can search multiple item with ,(comma)

    group_name

    Max Length : [20]

    Group Name

    Name of member group.

    You can search multiple item with ,(comma)

    Get a customergroup

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    group_no
    Required

    Group number

    System assigned member group number. This code cannot be duplicated.

    Customers

    Customers Entity

    Customers is customers who purchase products from shopping malls to receive coupons, reservations, discounts and other benefits from shopping malls. For membership management, a shopping mall operator may classify a member as a specific member class or designate a special member.

    Customers properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    member_id

    Max Length : [20]

    Member id

    member ID

    name

    Name

    name of the customer

    available_mileage

    Available mileage

    available mileage of the customer

    group_no

    Group number

    number of member group of the customer

    member_authentication

    Member authentication

    Member authentication type. Customer divided as 4 types based on member authentication.

    T: Authorized
    F: Unauthorized
    B: Special management member
    J: Members below 14 years old

    use_blacklist

    Whether the member is blacklist

    Whether customer is a blacklist or not. You may limit the customer action for log-in, purchase, and both log-in and purchase.

    T: Set
    F: Not set

    blacklist_type

    Blacklist type

    Blacklist type of the customer. You may limit the customer action for log-in, purchase, and both log-in and purchase.

    P: Block purchase
    L: Block log-in
    A: Block both log-in and purchase

    Search customers

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    cellphone
    Required

    Mobile

    The cellphone number for search shopping mall customers. In order to protect personal information, all numbers must be entererd in order to be able to search.

    Customers memos

    Customers memos properties

    Attribute Description
    shop_no

    Shop Number

    memo_no

    Memo number

    System assigned code. This code cannot be duplicated.

    author_id

    Author ID

    ID of memo writer.

    memo

    Memo description

    Contents of memo. You may input this with HTML..

    important_flag

    Important memo

    Flag for distinguish important memo.

    T: Important memo
    F: General memo

    created_date

    timezone

    Created date

    Written date of memo.

    Count all customers memos

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 2
    }
    

    Specification

    Property Description
    SCOPE READ_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    member_id
    Required

    Member id

    member id

    List all customers memos

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    member_id
    Required

    Member id

    member id

    limit

    Max : [100]

    Limit

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

    DEFAULT 10

    offset

    Max : [10000]

    Start location of list

    Set the start location of search result.

    Get a customers memo

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    memo_no
    Required

    Memo number

    System assigned code. This code cannot be duplicated.

    member_id
    Required

    Member id

    member id

    Create a customers memo

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    member_id
    Required

    Member id

    member id

    author_id
    Required

    Max Length : [20]

    Author ID

    ID of memo writer.

    memo
    Required

    Important memo

    Contents of memo. You may input this with HTML..

    important_flag

    Important memo

    Flag for distinguish important memo.

    T: Important memo
    F: General memo

    DEFAULT F

    Update a customers memo

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    memo_no
    Required

    Memo number

    System assigned code. This code cannot be duplicated.

    member_id
    Required

    Member id

    member id

    author_id
    Required

    Max Length : [20]

    Author ID

    ID of memo writer.

    memo

    Important memo

    Contents of memo. You may input this with HTML..

    important_flag

    Important memo

    Flag for distinguish important memo.

    T: Important memo
    F: General memo

    Delete a customers memo

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_CUSTOMER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    memo_no
    Required

    Memo number

    System assigned code. This code cannot be duplicated.

    member_id
    Required

    Member id

    member id

    Customers reviews

    Customer Reviews is a relational entity that allows you to see a list of reviews created by shopper customers.

    Customers reviews properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    product_no

    상품번호

    review_no

    리뷰 번호

    order_id

    Order ID

    주문 번호

    order number

    nickname

    작성자 별명

    title

    리뷰 제목

    content

    리뷰 내용

    content_text_length

    리뷰글 텍스트 길이

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    writer

    작성자명

    writing_id

    작성자 회원 아이디

    created_date

    Date
    timezone

    작성일자

    comment_count

    댓글 갯수

    like_count

    Min : [0]

    좋아요 횟수

    share_count

    Min : [0]

    SNS 공유 횟수

    hit_count

    Min : [0]

    조회수

    additional_information

    추가 항목

    images

    첨부 이미지

    Image that attached at review.

    tags

    해시태그

    rating

    평점

    Rating of review.

    use_share

    SNS 공유 여부

    Whether share review to SNS.

    T : 공유함
    F : 공유안함

    display

    게시 여부

    Whether display or not.

    T : 게시함
    F : 게시안함

    deleted

    삭제 여부

    Whether deleted or not.

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

    List all customers reviews

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no

    리뷰 번호

    writing_id
    Required

    작성자 회원 아이디

    Member ID of review writer.

    created_start_date

    Date
    timezone

    작성일 검색 시작일

    Search for reviews that created after certain date.

    created_end_date

    Date
    timezone

    작성일 검색 종료일

    Search for reviews that created before certain date.

    deleted

    삭제된 리뷰글 여부

    =VLOOKUP(C812,$C$276:H1534,5,0)

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

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    Review wrote path

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    Search for reviews that has comment.

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

    has_image

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

    Search for reviews that has image attachment.

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

    search_key

    검색 대상 항목

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

    keyword

    검색어

    mileage

    적립금 지급 여부

    Whether mileage is provided or not.

    todo : 지급안함
    done : 지급함

    limit

    Min : [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    Min : [0]

    목록을 가져올 시작 위치

    Set the start location of search result.

    Get a customers review

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    Member ID of review writer.

    review_no
    Required

    리뷰 번호

    Count all customers reviews

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 2
    }
    

    Specification

    Property Description
    SCOPE READ_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    Member ID of review writer.

    created_start_date

    Date
    timezone

    작성일 검색 시작일

    Search for reviews that created after certain date.

    created_end_date

    Date
    timezone

    작성일 검색 종료일

    Search for reviews that created before certain date.

    deleted

    삭제된 리뷰글 여부

    Whether deleted or not.

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

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    Search for reviews that has comment.

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

    has_image

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

    Search for reviews that has image attachment.

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

    search_key

    검색 대상 항목

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

    keyword

    검색어

    mileage

    적립금 지급 여부

    Whether mileage is provided or not.

    todo : 지급안함
    done : 지급함

    Customersprivacy

    Customersprivacy properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    member_id

    Max Length : [20]

    Member id

    member ID

    name

    Name

    name of the customer

    name_english

    English name

    English name of the customer

    name_phonetic

    Phonetic transcription name (Japanese)

    phonetic name of the customer(Japanese)

    phone

    Office phone number

    phone of the customer

    cellphone

    Mobile

    mobile of the customer

    email

    Email

    email of the customer

    sms

    Whether to receive SMS

    Whether receive SMS or not. 'Do not receive' status receives only important mail such as order status, service information.

    T: Receive
    F: Do not receive

    news_mail

    Whether to receive news mails

    Whether receive email or not. 'Do not receive' status receives only important mail such as order status, service information. 'Never receive email' status doesn't receives not only commercial mail but also important service or order related emails.

    T: Receive
    F: Do not receive
    D: Never receive email

    wedding_anniversary

    Date

    Wedding anniversary

    wedding anniversary of the customer

    birthday

    Date

    Birthday

    Birthday of the customer

    solar_calendar

    Whether it is a solar calendar

    Whether birthday is based on solar calendar or not.

    T: Solar calendar
    F: Lunar calendar

    total_mileage

    Total mileage

    total mileage of the customer

    available_mileage

    Available mileage

    available mileage of the customer

    used_mileage

    Used mileage

    used mileage of the customer

    address1

    Max Length : [255]

    Address 1

    The primary address of the customer. (city / county / province)

    address2

    Max Length : [255]

    Address 2

    The detailed address of the customer.

    group_no

    Group number

    number of member group of the customer

    job_class

    Job class

    job class of the customer

    job

    Job

    job of the customer

    zipcode

    Max Length : [14]

    Zipcode

    created_date

    timezone

    Created date

    signup date of the customer

    member_authentication

    Member authentication

    Member authentication type. Customer divided as 4 types based on member authentication.

    T: Authorized
    F: Unauthorized
    B: Special management member
    J: Members below 14 years old

    use_blacklist

    Whether the member is blacklist

    Whether customer is a blacklist or not. You may limit the customer action for log-in, purchase, and both log-in and purchase.

    T: Set
    F: Not set

    pointfy_member

    Pointify Member Flag

    Whether customer using pointfy or not. Mall may use pointfy service when mall has a single brand and want to unify membership with offline and online.

    T: Set
    F: Not set

    blacklist_type

    Blacklist type

    Blacklist type of the customer. You may limit the customer action for log-in, purchase, and both log-in and purchase.

    P: Block purchase
    L: Block log-in
    A: Block both log-in and purchase

    last_login_date

    timezone

    Last login date

    last login date of the customer

    member_authority

    Member authority

    Member authority classification. Member authority is separated to representative operator, sub operator, supplier, and ordinary member.

    C: General member
    P: Representative operator
    A: Sub-operator
    S: Supplier

    nick_name

    Max Length : [50]

    Nick name

    nick name of the customer

    recommend_id

    Recommended id

    referrer ID that customer entered when joined member

    residence

    Residence

    residence of the customer

    interest

    Interest

    interest of the customer

    gender

    Gender

    Gender of the customer

    M: Male
    F: Female

    member_type

    Member type

    member type of the customer

    P: Individual
    C: Business
    F: Foreigner

    company_type

    Company type

    In case member type is Business

    p: Individual business
    c: Corporate business

    foreigner_type

    Foreigner type

    way how authenticate the foreign member in Korea

    F: Foreigner registration number
    P: Passport number
    D: International driver's license

    corporate_name

    Corporate name

    corporate name of the customer

    nationality

    Nationality

    If the customer is a "foreign member", the nationality of the customer

    shop_name

    Shop name

    shop name of the customer

    country_code

    Country code

    The country of the customer

    use_mobile_app

    Whether to use mobile app

    whether customer using mobile app or not

    T: Using mobile app
    F: Do not using mobile app

    available_deposit

    가용 예치금

    It can be displayed only in detail inquiry.

    additional_information

    Additional information list

    Additional information of the customer
    You may confirm 'additional information' at Customer detail search API.

    It can be displayed only in detail inquiry.

    List all customersprivacy

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_PRIVACY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    search_type

    Search type

    customer_info : Search by customer information
    created_date : Search by join date

    DEFAULT customer_info

    created_start_date

    Date
    timezone

    If search by join date the search start date

    member_id

    Max Length : [20]

    Member id

    member ID

    news_mail

    Whether to receive news mails

    Whether receive email or not. 'Do not receive' status receives only important mail such as order status, service information. 'Never receive email' status doesn't receives not only commercial mail but also important service or order related emails.

    T: Receive
    F: Do not receive
    D: Never receive email

    sms

    Whether to receive SMS

    Whether receive SMS or not. 'Do not receive' status receives only important mail such as order status, service information.

    T: Receive
    F: Do not receive

    group_no

    Group number

    number of member group of the customer

    search_field

    Search field

    Search field for targeted member.

    id: ID
    name: Name
    hp: Mobile phone
    tel: Telephone number
    mail: E-mail

    keyword

    Keyword

    Input search term of search field that targeted to search.
    ex) search_field : mail
    keyword : cafe24@cafe24.com

    You can search multiple item with ,(comma)

    date_type

    Date type

    Search criteria for search targeted member. Search start date and Search end date would be the time period of signup date if the search criteria is 'join'.

    join: Member registration date
    log-in: Recent access date
    age: Birthday

    start_date

    Date
    timezone

    Search Start Date

    Search start date for specific search criteria.
    Must use with 'end_date' simultaneously.
    Search only on specific date if search start and end dates are the same.
    example) 2018-12-31 00:00:00

    end_date

    Date
    timezone

    Search End Date

    Search end date for specific search criteria.
    Must use with 'start date' simultaneously.
    Search only on specific date if search start and end dates are the same.
    example) 2018-12-31 23:59:59

    member_type

    Member type

    member type of the customer

    P: Individual
    C: Business
    F: Foreigner

    residence

    Residence

    residence of the customer

    You can search multiple item with ,(comma)

    gender

    Gender

    Gender of the customer

    M: Male
    F: Female

    member_authority

    Member authority

    Member authority classification. Member authority is separated to representative operator, sub operator, supplier, and ordinary member.

    C: General member
    P: Representative operator
    A: Sub-operator
    S: Supplier

    DEFAULT C

    limit

    Max : [1000]

    Limit

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

    DEFAULT 30

    offset

    Max : [8000]

    Start location of list

    Set the start location of search result.

    Count all customersprivacy

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 3
    }
    

    Specification

    Property Description
    SCOPE READ_PRIVACY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    search_type

    Search type

    customer_info : Search by customer information
    created_date : Search by join date

    DEFAULT customer_info

    created_start_date

    Date
    timezone

    If search by join date the search start date

    member_id

    Max Length : [20]

    Member id

    member ID

    news_mail

    Whether to receive news mails

    Whether receive email or not. 'Do not receive' status receives only important mail such as order status, service information. 'Never receive email' status doesn't receives not only commercial mail but also important service or order related emails.

    T: Receive
    F: Do not receive
    D: Never receive email

    sms

    Whether to receive SMS

    Whether receive event SMS or not. 'Do not receive' status receives only important mail such as order status, service information.

    T: Receive
    F: Do not receive

    group_no

    Group number

    number of member group of the customer

    search_field

    Search field

    Search field for targeted member.

    id: ID
    name: Name
    hp: Mobile phone
    tel: Telephone number
    mail: E-mail

    keyword

    Keyword

    You can search multiple item with ,(comma)

    date_type

    Date type

    join: Member registration date
    log-in: Recent access date
    age: Birthday

    start_date

    Date
    timezone

    Search Start Date

    Search start date for specific search criteria.
    Must use with 'end_date' simultaneously.
    Search only on specific date if search start and end dates are the same.
    example) 2018-12-31 00:00:00

    end_date

    Date
    timezone

    Search End Date

    Search end date for specific search criteria.
    Must use with 'start date' simultaneously.
    Search only on specific date if search start and end dates are the same.
    example) 2018-12-31 23:59:59

    member_type

    Member type

    member type of the customer

    P: Individual
    C: Business
    F: Foreigner

    residence

    Residence

    residence of the customer

    You can search multiple item with ,(comma)

    gender

    Gender

    Gender of the customer

    M: Male
    F: Female

    member_authority

    Member authority

    Member authority classification. Member authority is separated to representative operator, sub operator, supplier, and ordinary member.

    C: General member
    P: Representative operator
    A: Sub-operator
    S: Supplier

    DEFAULT C

    Get a customersprivacy

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_PRIVACY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    member_id
    Required

    Max Length : [20]

    Member id

    member ID

    Dashboard

    Dashboard is a brief summary of shopping mall operation information such as order status and sales status.

    Dashboard properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    daily_sales_stats

    Daily sales stats

    Daily sales information.

    weekly_sales_stats

    Weekly sales stats

    Weekly sales information.

    monthly_sales_stats

    Monthly sales stats

    Monthly sales information.

    sold_out_products_count

    Number of the products sold out

    Number of soldout products. Counts only for products which using both soldout option and inventory management option.

    new_members_count

    Number of new members

    Number of newly signed up customer.

    board_list

    Board list

    Board list of a mall.

    Get dashboard

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_STORE
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    Mains

    Mains Entity

    The main category (Mains) is a product category that can display products of the shopping mall on the main screen.

    Mains properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    module_code

    Module code

    The module code assigned main display group

    display_group

    Display Group

    group_name

    Group Name

    soldout_sort_type

    Sold-out product display status

    The display location of sold out products.

    B: Arranged out-of-stock items to the back
    F: Arranged out-of-stock items to the front
    N: N/A

    List all mains

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_CATEGORY
    Request Limit 30

    Mains products

    Mains products properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    product_no

    Product number

    product_name

    Product name

    display_order

    Display order

    Rank of product display.

    The displayed order may not be displayed sequentially when the displayed merchandise is deleted.

    Ex) If the fourth item is deleted, 1,2,3,5,6,7 ... Can be displayed in order.

    Products that have fixed display rankings, 9,999,999 is added to the display rank number.

    List all mains products

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    display_group
    Required

    Display Group

    Count all mains products

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 3
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    display_group
    Required

    Display Group

    Create a mains product

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    display_group
    Required

    Display Group

    product_no
    Required

    Product number

    Update a mains product

    Update a Mains Products is only possible to change the order. It does not support adding or deleting products to the main display through the API. Before you use this API, Use "List all Mains products" API for get displayed products.

    Only the main display group with a maximum of 200 items can be reordered

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    display_group
    Required

    Display Group

    product_no
    Required

    Product number

    Rank of product display will designated for requested order.

    fix_product_no

    Fixed product number

    Designate product for fixed rank.

    Delete a mains product

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    display_group
    Required

    Display Group

    product_no
    Required

    Product number

    Manufacturers

    Manufacturers is an information entered into the "production information" of a product. The manufacturer represents the subject who produced and produced the product, and is one of the sales categories that distinguish the products. The product must have one manufacturer (using "own manufacturer" when not specified)
    Manufacturers' {#id} is "manufacturer_code".

    Manufacturers properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    manufacturer_code

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

    Manufacturer code

    Unique number of each manufacturer. This number cannot be duplicated in a mall.

    manufacturer_name

    Max Length : [50]

    Manufacturer name

    Name of manufacturer. Manufacturer name is the basic information for mall to distinguish each manufacturer.

    president_name

    Max Length : [30]

    CEO

    President name of manufacturer.

    use_manufacturer

    Use classification

    Whether use the manufacturer or not.

    T: Use
    F: Do not use

    email

    Max Length : [255]

    Email

    Email of manufacturer.

    It can be displayed only in detail inquiry.

    phone

    Max Length : [20]

    Office phone number

    Phone number of manufacturer.

    It can be displayed only in detail inquiry.

    homepage

    Max Length : [255]

    Home page

    Website address of manufacturer.

    It can be displayed only in detail inquiry.

    zipcode

    Zipcode

    Zipcode of manufacturer.

    It can be displayed only in detail inquiry.

    address1

    Max Length : [255]

    Address 1

    Address1 of manufacturer. (Street address, P.O. box, company name, c/o)

    It can be displayed only in detail inquiry.

    address2

    Max Length : [255]

    Address 2

    Address2 of manufacturer. (Apartment, suite, unit, building, floor, etc)

    It can be displayed only in detail inquiry.

    created_date

    timezone

    Created date

    It can be displayed only in detail inquiry.

    List all manufacturers

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    manufacturer_code

    Manufacturer code

    Code of manufacturer to search.

    You can search multiple item with ,(comma)

    manufacturer_name

    Manufacturer name

    You can search multiple item with ,(comma)

    use_manufacturer

    Use manufacturer

    T: Use
    F: Do not use

    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.

    Get a manufacturer

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    manufacturer_code
    Required

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

    Manufacturer code

    Count all manufacturers

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 2
    }
    

    Specification

    Property Description
    SCOPE READ_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    manufacturer_code

    Manufacturer code

    Code of manufacturer to search.

    You can search multiple item with ,(comma)

    manufacturer_name

    Manufacturer name

    Search for manufacturer that contain search terms in a manufacturer name. (Case Insensitive)

    You can search multiple item with ,(comma)

    use_manufacturer

    Use manufacturer

    T: Use
    F: Do not use

    Create a manufacturer

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    manufacturer_name
    Required

    Max Length : [50]

    Manufacturer name

    president_name
    Required

    Max Length : [30]

    CEO

    email

    Email
    Max Length : [255]

    Email

    phone

    Phone Number
    Max Length : [20]

    Office phone number

    homepage

    Max Length : [255]

    Home page

    zipcode

    Zipcode

    address1

    Max Length : [255]

    Address 1

    address2

    Max Length : [255]

    Address 2

    use_manufacturer

    Use classification

    T: Use
    F: Do not use

    Update a manufacturer

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    manufacturer_code
    Required

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

    Manufacturer code

    manufacturer_name

    Max Length : [50]

    Manufacturer name

    president_name

    Max Length : [30]

    CEO

    email

    Email
    Max Length : [255]

    Email

    phone

    Phone Number
    Max Length : [20]

    Office phone number

    homepage

    Max Length : [255]

    Home page

    zipcode

    Zipcode

    address1

    Max Length : [255]

    Address 1

    address2

    Max Length : [255]

    Address 2

    use_manufacturer

    Use classification

    T: Use
    F: Do not use

    Orders

    Orders Entity

    Order is a request from a shopping mall customer to a shopping mall to purchase a product. The shop operator will deliver the goods to the shopping mall customer based on the order information that has been paid. The order information includes information about the orderer who made the order and payment, and the recipient information for shipping the item.

    The {#id} in Orders is "order_id".

    The order has the following Entity as a embedded Entity.
    Items
    Recipient Information

    Orders properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    currency

    Currency

    Currecy unit of a mall.

    order_id

    Order ID

    Order number.

    market_id

    Market id

    Unique ID of a market for distinguish each website in case customer purchase through price comparison site.

    market_order_info

    Market order information

    Other information of market or order path.

    buyer_name

    Orderer name

    Name of orderer. May differ from billing name or recipient name.

    buyer_email

    Buyer Email

    Email of orderer. May differ from billing email or recipient email.

    buyer_phone

    Orderer phone number

    Phone number of orderer. May differ from billing phone number or recipient phone number.

    buyer_cellphone

    Buyer mobile number

    Mobile phone of orderer. May differ from billing mobile phone or recipient mobile phone.

    member_id

    Member id

    member id

    member_authentication

    Member authentication

    Member authentication type. Customer divided as 4 types based on member authentication.

    T: authorized
    B: special treatment member J: under 14

    billing_name

    Billing name

    Name of billing. May differ from orderer name or recipient name.

    bank_code

    Bank code

    Bank code of billing.

    bank_code_name

    Bank name

    Bank name of billing.

    payment_method

    Payment method code

    Code of payment method that orderer used for payment.

    payment_method_name

    Payment method name

    Name of payment method that orderer used for payment.

    payment_method_icon

    Payment method icon

    Icon of payment method.

    payment_gateway_name

    Payment gateway name

    Name of payment gateway that orderer used for payment.

    paid

    Paid

    Whether the order paid or not.

    T: Paid
    F: Unpaid

    order_date

    timezone

    Ordered date

    Date of order.

    first_order

    First order

    Whether the order is the first order from the customer or not.

    T: First order
    F: Not first order

    payment_date

    timezone

    Payment date

    Payment Date

    order_from_mobile

    Mobile type

    whether order made on mobile

    T: Made on mobile
    F: Was not made on mobile

    order_price_amount

    Order Amount

    amount of order price

    use_escrow

    Whether to use Escrow

    whether customer used escrow or not

    T: Used escrow
    F: Do not used escrow

    customer_group_no_when_ordering

    Customer group number when ordering

    Customer group number when order occurred.

    membership_discount_amount

    Discount for member

    amount of discount for membership

    app_discount_amount

    앱 주문할인금액

    actual_payment_amount

    Actual payment amount

    Actual amount of payment that customer paid. This may change when customer canceled, exchanged, or returned for the order.

    mileage_spent_amount

    Mileage spent amount

    amount of mileage payment

    bank_account_no

    Bank account no

    Bank account number of shooping mall of the specific order.

    market_customer_id

    Market customer id

    id of market customer

    payment_amount

    Payment amount

    Payment amount. This amount won't change once payment confirmed.

    cancel_date

    timezone

    Order cancellation date

    date of cancellation of an order.

    inflow_name

    Inflow channel name

    name of inflow channel

    inflow_id

    Inflow Channel ID

    id of inflow channel

    order_place_name

    Order path text

    order_place_id

    Available order path

    payment_confirmation

    Whether payment is confirmed

    whether payment confirmed or not

    T: confirmed payment
    F: payment does not confirmed

    postpay_commission

    Post payment service fee

    service fee for using post payment service

    postpay

    Whether postpaid

    whether the payment method is post payment or not

    T: Payment after delivery
    F: No payment after delivery

    shipping_fee

    Shipping fee

    shipping fee

    shipping_type

    Delivery type

    Shipping delivery type. Whether domestic shipping or abroad shipping or both.

    A: Domestic
    B: Domestic and overseas
    C: Overseas

    shipping_type_text

    Delivery type

    Description of shipping type. Whether domestic shipping or abroad shipping or both.

    shipping_status

    Delivery status

    shipping status

    F: Before delivery
    M: During delivery
    T: Delivery completed
    W: Delivery hold

    wished_delivery_date

    Desired delivery date

    delivery date which customer wants

    wished_delivery_time

    Desired delivery time

    delivery time which customer wants

    wished_carrier_id

    Desired courier code

    Carrier ID which customer wants

    return_confirmed_date

    timezone

    Return approval time

    date of return confirmation

    total_supply_price

    Total supply price

    total supply price

    additional_order_info_list

    Additional order info

    store_pickup

    Store pickup

    whether customer can pick up a product at a store or not

    T: Store pickup
    F: No store pickup

    easypay_name

    Easypay payment gateway name

    name of easypay payment gateway

    loan_status

    Loan status

    status of loan

    OK : GOOD
    NG : NOT GOOD
    ER : ERROR

    shipping_message

    Shipping message

    shipping message

    items

    Item entity

    receivers

    Receiver Entity

    buyer

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

    List all orders

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_ORDER
    Request Limit 30

    Request

    Parameter Description
    items
    embed

    Item entity

    receivers
    embed

    Receiver Entity

    buyer
    embed

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

    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    Search Start Date

    start date for search

    ※ In order to guarantee the API performance, you can search orders only for the last 3 months.

    end_date
    Required

    Date
    timezone

    Search End Date

    Search end date for specific search criteria.
    Must use with 'start_date' simultaneously.
    Search only on specific date if search start and end dates are the same.
    example) 2018-12-31 23:59:59

    ※ In order to guarantee the API performance, you can search orders only for the last 3 months.

    order_id

    Order ID

    Order ID

    order number

    You can search multiple item with ,(comma)

    order_status

    Order status

    Order status. Each status has its own code.

    You can search multiple item with ,(comma)

    N00: Before deposit
    N10: Preparing products
    N20: Preparing for delivery
    N21: Ready to deliver
    N22: Delivery hold
    N30: During delivery
    N40: Delivery completed

    member_type

    Member type

    Whether member or not. Each has its own code.

    2: Member
    3: Nonmember

    group_no

    Group number

    Group number of a customer.

    buyer_name

    Buyer name

    Name of orderer. May differ from billing name or recipient name.

    receiver_name

    Receiver name

    Name of recipient. May differ from orderer name or billing name.

    receiver_address

    Receiver address

    Address of recipient. May differ from orderer address or billing address.

    member_id

    Member id

    member id

    product_no

    Product number

    System assigned code. This code cannot be duplicated.

    product_code

    Product code

    System assigned code. This code cannot be duplicated.

    date_type

    Date type

    Date type for search. Default is date of order.

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

    DEFAULT order_date

    supplier_id

    Supplier id

    limit

    Max : [500]

    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 orders

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 3
    }
    

    Specification

    Property Description
    SCOPE READ_ORDER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    Search Start Date

    Search start date for specific search criteria.
    Must use with 'end_date' simultaneously.
    Search only on specific date if search start and end dates are the same.
    example) 2018-12-31 00:00:00

    end_date
    Required

    Date
    timezone

    Search End Date

    Search end date for specific search criteria.
    Must use with 'start_date' simultaneously.
    Search only on specific date if search start and end dates are the same.
    example) 2018-12-31 23:59:59

    order_id

    Order ID

    Order ID

    order number

    You can search multiple item with ,(comma)

    order_status

    Order status

    Order status. Each status has its own code.

    You can search multiple item with ,(comma)

    N00: Before deposit
    N10: Preparing products
    N20: Preparing for delivery
    N21: Ready to deliver
    N22: Delivery hold
    N30: During delivery
    N40: Delivery completed

    member_type

    Member type

    Whether member or not. Each has its own code.

    2: Member
    3: Nonmember

    group_no

    Group number

    Group number of a customer.

    buyer_name

    Buyer name

    Name of orderer. May differ from billing name or recipient name.

    receiver_name

    Receiver name

    Name of recipient. May differ from orderer name or billing name.

    receiver_address

    Receiver address

    Address of recipient. May differ from orderer address or billing address.

    member_id

    Member id

    member id

    product_no

    Product number

    product_code

    Product code

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

    date_type

    Date type

    date type criteria for search. Default criteria is order date.

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

    DEFAULT order_date

    supplier_id

    Supplier id

    Orders buyer

    Orders buyer properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    member_id

    주문자 아이디

    member id

    member_group_no

    주문당시 주문자 회원 등급 번호

    Customer group number.

    name

    주문자명

    Name of recipient. May differ from orderer name or billing name.

    email

    주문자 이메일

    email of the customer

    phone

    주문자 일반 전화

    Phone number of a buyer.

    cellphone

    주문자 휴대 전화

    Cellphone number of a buyer.

    customer_notification

    고객 알림

    Note for customer to know.

    updated_date

    timezone

    수정일

    user_id

    주문자 수정자 ID

    Id of a person who updated buyer information.

    user_name

    주문자 수정자 명

    Nmae of a person who updated buyer information.

    order_id

    Order ID

    주문번호

    order number

    Get an orders buyer

    Definition

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

    Request example:

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

    Response example:

    {
        "buyer": {
            "shop_no": 1,
            "member_id": "sampleid",
            "member_group_no": 1,
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample",
            "updated_date": "2018-09-03T17:20:49+09:00",
            "user_id": "sampleid",
            "user_name": "John Doe"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_ORDER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    DEFAULT 1

    order_id
    Required

    Order ID

    주문번호

    order number

    Update an orders buyer

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/orders/20180903-0000243/buyer' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample"
        }
    }'
    

    Response example:

    {
        "buyer": {
            "shop_no": 1,
            "order_id": "20180903-0000243",
            "name": "Floyd Mayweather",
            "email": "sample@gmail.com",
            "phone": "02-0000-0000",
            "cellphone": "010-0000-0000",
            "customer_notification": "Customer Notify Sample"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_ORDER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    order_id
    Required

    Order ID

    주문번호

    order number

    name

    주문자명

    Name of recipient. May differ from orderer name or billing name.

    email

    Email

    주문자 이메일

    email of the customer

    phone

    주문자 일반 전화

    Phone number of a buyer.

    cellphone

    주문자 휴대 전화

    Cellphone number of a buyer.

    customer_notification

    고객 알림

    Note for customer to know.

    Orders items

    Items is the item information purchased by the shopping mall customer when ordering. Items in the shopping mall are the basic units of items sold in the shopping mall. In addition to the item information of the purchased items, you can also check the information on the options, order quantity, and so on.
    Items can only be used in the Order subset as a embedded Entity.
    The {#id} of Items is "item_no".

    Orders items properties

    Attribute Description
    shop_no

    Shop Number

    DEFAULT 1

    item_no

    Item no

    Identification number of order item.

    order_item_code

    Order item code

    Identification code of order item.

    variant_code

    Variant code

    System assigned code to variant. This code cannot be duplicated.

    product_no

    Product number

    System assigned code. This code cannot be duplicated.

    product_code

    Product code

    System assigned code. This code cannot be duplicated.

    eng_product_name

    English name of product

    English name of product. Necessary when shipping to abroad.

    option_id

    Option id

    Identification number of product option.

    option_value

    Option value

    Option value of product option.

    option_value_default

    Default option

    Default option value of product option.

    additional_option_value

    Additional option value

    Additional option value of product option.

    product_name

    Product name

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

    product_name_default

    Default product name

    Product name.

    product_price

    Product price

    Product price. If mall using multi mall, the price will be transfer to multi mall currency.

    option_price

    Option price

    Additional price when option has additional price.

    additional_discount_price

    Additional discount price

    Additional discount price for product.

    app_item_discount_amount

    앱 상품할인금액

    quantity

    Available inventory

    Quantity of ordered product.

    supplier_product_name

    Supplier product name

    Product name of supplier.

    supplier_transaction_type

    Supplier transaction type

    Transaction type of supplier.

    D: Direct registration type
    P: Fee type

    supplier_id

    Supplier id

    ID of supplier.

    supplier_name

    Supplier name

    Name of supplier.

    tracking_no

    Tracking number

    Tracking number of order.

    shipping_code

    Shipping code

    Shipping code of order. System assigns the code when order status changes to 'Ready for shipping : N21' status.

    post_express_flag

    Post express flag

    Whether post express linked or not.

    order_status

    Order status

    Order status. Each status has its own code.

    order_status_additional_info

    Order status additional info

    order status additional info

    status_code

    Status code

    Current status code.

    N1: Normal
    N2: Exchanged product
    C1: Cancelled before deposit
    C2: Cancelled before delivery
    C3: Return
    E1: Exchange

    status_text

    Status text

    Description of current status.

    open_market_status

    Open market status

    Open market status.

    bundled_shipping_type

    Open market status

    Bundel shipping type of the order.

    N: 단일 주문 일반 배송(Normal)
    C:복합 주문 결합 배송(Combination)

    shipping_company_id

    Shipping company id

    ID of shipping company.

    shipping_company_name

    Shipping company name

    Name of shipping company.

    shipping_company_code

    Shipping company code

    Code of shipping company. Each company has a unique code.

    product_bundle

    Product bundle

    Whether product is bundle product or not.

    T: Set product
    F: No set product

    product_bundle_no

    분리형 세트상품번호

    Number of Separable bundle product.
    The number of inseparable product is displayed in product_no

    product_bundle_name

    분리형 세트상품명

    Name of separable bundle product.
    The name of inseparable product is displayed in "product_name"

    product_bundle_name_default

    분리형 세트상품명(기본)

    Name of separable bundle product. (default)
    The name of inseparable product is displayed in "product_name"

    product_bundle_type

    Product bundle type

    Type of bundle product.

    C: Integrated type
    S: Separated type

    was_product_bundle

    Was product bundled

    Whether bundle product has been separated or not.

    T: Has been separated
    F: Has not been separated

    original_bundle_item_no

    Original bundle item no

    Original item number of separated buldle product.

    naver_pay_order_id

    Naver pay order ID

    Order ID of order from 'Naver pay'.

    naver_pay_claim_status

    Naver pay claim status

    Claim type of order from 'Naver pay'.

    PAYMENT_WAITING: Deposit on standby
    PAID: Payment completed
    DELIVERING: During delivery
    DELIVERED: Delivery completed
    PURCHASE_DECIDED: Purchase confirmed
    EXCHANGED: Exchanged
    CANCELLED: Cancelled
    RETURNED: Returned
    CANCELLED_BY_NOPAYMENT: Cancelled because of no payment
    NOT_YET: Order not checked
    OK: Order checked
    CANCEL: Order check cancelled
    CANCEL_REQUEST: Request for a cancellation
    CANCELLING: Cancelling
    CANCEL_DONE: Cancelled completely
    CANCEL_REJECT: Cancellation requested
    RETURN_REQUEST: Request for return
    COLLECTING: Collecting
    COLLECT_DONE: Collected completely
    RETURN_DONE: Return completed
    RETURN_REJECT: Return cancelled
    EXCHANGE_REQUEST: Request for exchange
    COLLECTING: Collecting
    COLLECT_DONE: Collected completely
    EXCHANGE_REDELIVERING: During redelivery after exchange
    EXCHANGE_DONE: Exchange completed
    EXCHANGE_REJECT: Exchange rejected
    PURCHASE_DECISION_HOLDBACK: Purchase confirmation hold
    PURCHASE_DECISION_HOLDBACK_REDELIVERING: During delivery after purchase confirmation hold
    PURCHASE_DECISION_REQUEST: Request for purchase confirmation
    PURCHASE_DECISION_HOLDBACK_RELEASE: Cancellation of purchase confirmation hold
    ADMIN_CANCELLING: Authority being cancelled
    ADMIN_CANCEL_DONE: Authority completely cancelled

    individual_shipping_fee

    Individual shipping fee

    Individual shipping fee of order.

    shipping_fee_type

    Shipping charge

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

    T: Free
    F: Payment after delivery
    D: Differential (Amount)
    M: Conditional (Amount)
    I: Fixed
    N: Proportional (Quantity)
    W: Differential (Weight)
    C: Differential (Quantity)
    X: Standard delivery

    shipping_fee_type_text

    Shipping fee type

    Description of shipping fee type.

    payment_info_id

    Payment information ID

    ID of payment information.

    original_item_no

    Original item no

    ID of original item number.

    store_pickup

    Store pickup

    Whether the order can pickup at an offline store or not.

    T: Store pickup
    F: No store pickup

    ordered_date

    timezone

    Ordered date

    Date of order.

    shipped_date

    timezone

    Shipped date

    Date of shipping started.

    delivered_date

    timezone

    Delivered date

    Delivered date of order.

    cancel_date

    timezone

    Order cancellation date

    Date of order canceled.

    return_request_date

    timezone

    Return request date

    Date of return requested.

    return_date

    timezone

    Return date

    Date of return completed.

    cancel_request_date

    timezone

    Cancellation request date

    Date of request order cancel.

    refund_date

    timezone

    Refund date

    Date of refund completed.

    exchange_request_date

    timezone

    Exchange request date

    Date of request exchange.

    exchange_date

    timezone

    Exchange date

    Date of exchange completed.

    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.

    product_material_eng

    English product material

    Description of product material in English.

    cloth_fabric

    Fabric of product

    In case cloth products using a Japanese courier service, material information may required for some shipping companies.

    product_weight

    Weight of product

    Weight of whole product. Total weight including product, box, and packing weight is necessary for shipping.

    volume_size

    Product volume

    Volume size of a product.

    volume_size_weight

    Volume size weight

    volumetric weight of a product.

    clearance_category

    Clearance category code

    Category code for the purpose of customs clearance.

    clearance_category_info

    Clearance category information

    clearance_category_code

    Clearance category code

    Category code for the purpose of customs clearance.

    hs_code

    HS code

    HS code for customs clerance.

    one_plus_n_event

    One plus n event

    Whether 1 plus N event or not.

    origin_place

    Origin

    Search for products that include keyword in the origin place. (Case Insensitive)

    gift

    Gift

    Whether product is for gift or not.

    T: gift
    F: not a gift

    List all orders items

    Definition

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

    Request example:

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

    Response example:

    {
        "items": [
            {
                "shop_no": "1",
                "item_no": "1",
                "order_item_code": "20170710-0000013-01",
                "variant_code": "P000000N000A",
                "product_no": "14",
                "product_code": "P000000N",
                "eng_product_name": null,
                "option_id": "000A",
                "option_value": "",
                "option_value_default": "",
                "additional_option_value": "",
                "product_name": "iPhone X",
                "product_name_default": "iPhone X",
                "product_price": "30000.00",
                "option_price": "0.00",
                "additional_discount_price": "0.00",
                "app_item_discount_amount": "0.00",
                "quantity": "1",
                "supplier_product_name": "",
                "supplier_transaction_type": "D",
                "supplier_id": "S0000000",
                "supplier_name": "Apple",
                "tracking_no": "12345678",
                "shipping_code": "D-20170710-0000013-00",
                "post_express_flag": null,
                "order_status": "N40",
                "order_status_additional_info": null,
                "status_code": "N1",
                "status_text": "Shipping Complete",
                "open_market_status": "",
                "bundled_shipping_type": "N",
                "shipping_company_id": "2",
                "shipping_company_name": "DHL",
                "shipping_company_code": "0001",
                "product_bundle": "F",
                "product_bundle_no": "0",
                "product_bundle_name": null,
                "product_bundle_name_default": null,
                "product_bundle_type": "C",
                "was_product_bundle": null,
                "original_bundle_item_no": null,
                "naver_pay_order_id": null,
                "naver_pay_claim_status": "PAYMENT_WAITING",
                "individual_shipping_fee": "0.00",
                "shipping_fee_type": "X",
                "shipping_fee_type_text": "Free",
                "payment_info_id": "0",
                "original_item_no": "",
                "store_pickup": "F",
                "ordered_date": "2017-07-10 15:55:51",
                "shipped_date": "2017-07-10 15:56:52",
                "delivered_date": "2017-07-10 15:57:05",
                "cancel_date": null,
                "return_request_date": null,
                "return_date": null,
                "cancel_request_date": null,
                "refund_date": null,
                "exchange_request_date": null,
                "exchange_date": null,
                "product_material": null,
                "product_material_eng": null,
                "cloth_fabric": null,
                "product_weight": "1.00",
                "volume_size": null,
                "volume_size_weight": null,
                "clearance_category_code": null,
                "clearance_category_code_info": null,
                "clearance_category_code_base": null,
                "hs_code": "",
                "one_plus_n_event": null,
                "origin_place": " ",
                "gift": "F"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_ORDER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    Order number.

    Orders receivers

    Receivers are the names, contacts, and address information of the recipients to whom the ordered goods will be shipped.
    Recipient can only be used in the Order subset as a embedded Entity.

    Orders receivers properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    name

    Receiver name

    Name of recipient. May differ from orderer name or billing name.

    name_furigana

    Receiver name (Pronunciation)

    Name of recipient in Japanese Furigana.

    phone

    Office phone number

    cellphone

    Receiver mobile phone number

    virtual_phone_no

    Receiver virtual number

    zipcode

    Zipcode

    address1

    Address 1

    address2

    Address 2

    name_en

    Receiver name (English)

    city_en

    Receiver city (English)

    state_en

    Receiver state (English)

    street_en

    Receiver address (English)

    country_code

    Country code

    country code

    country_name

    Country

    country name

    country_name_en

    Country (English)

    Country name in English

    List all orders receivers

    Definition

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

    Request example:

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

    Response example:

    {
        "receivers": [
            {
                "shop_no": 1,
                "name": "John Doe",
                "name_furigana": "John Doe",
                "phone": "02-0000-0000",
                "cellphone": "010-0000-0000",
                "virtual_phone_no": null,
                "zipcode": "06258",
                "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
                "address2": "Professional Construction Hall",
                "name_en": null,
                "city_en": null,
                "state_en": null,
                "street_en": null,
                "country_code": "",
                "country_name": null,
                "country_name_en": null
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_ORDER
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    Order number.

    Origin

    Origin means the region where the product was produced. Country of origin is important data for overseas shipping. Cafes 24 coded a variety of countries of origin, and the country of origin code information can be checked through the Origin search API.

    Origin properties

    Attribute Description
    origin_place_no

    Origin place no

    origin_place_name

    Origin place name

    foreign

    Foreign

    List all origin

    Definition

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

    Request example:

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

    Response example:

    {
        "origin": [
            {
                "origin_place_no": "1",
                "origin_place_name": [
                    "Gangwon",
                    "Gangneung-si"
                ],
                "foreign": "F"
            },
            {
                "origin_place_no": "2",
                "origin_place_name": [
                    "Gangwon",
                    "Goseong-gun"
                ],
                "foreign": "F"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_COLLECTION
    Request Limit 30

    Request

    Parameter Description
    origin_place_no

    Origin place no

    origin_place_name

    Max Length : [50]

    Origin place name

    foreign

    Foreign

    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.

    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.

    supply_product_name

    Max Length : [250]

    Supplier product name

    Supplier registered name of the product. Supplier may assign this name manually for some reasons. This name does not affect "Name of product".

    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.

    supply_price

    Product supply price

    Value of supply. You may calculate price using "supply_price" and "margin_rate".

    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_condition

    Product condition

    Displays condition of product

    N: New
    B: Once returned to a seller's warehouse.
    R: Carryover merchandise
    U: Used
    E: Displayed (Condition which already displayed at offline mall or sort of exhibition.)
    F: Refurbished (Condition which products have been previously returned to a manufacturer or vendor for various reasons. This condition includes repaired products from manufacturer. Refurbished products are usually tested by manufacturer or vendor.)
    S: Damaged

    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.

    margin_rate

    Min : [-999.99]~Max : [999.99]

    Margin rate

    Rate of margin. You may calculate price using "supply_price" and "margin_rate". In API, margin rate is used only for reperence purpose only.

    tax_type

    Taxation category

    Tax type information of product.

    Tax product : VAT, Sales tax, or other tax is included

    Tax free product : Tax free product such as un-processed agriculture products, fishery products, animal products, books, or etc.

    Products for tax free may differ from country to country.

    Zero tax product : Applicable as 0% rate of VAT.

    A: Taxable goods
    B: Duty-free goods
    C: Small goods

    tax_amount

    Min : [0]~Max : [100]

    Tax rate

    Tax rate should be informed for the taxable products.

    Tax rate of products may differ from country to country.

    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_limit_type

    Purchase limitation

    Limit purchase as below information.

    N: Members only and hide purchase button.
    M: Members only but does not hide purchase button.
    F: No limitation.

    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%

    except_member_mileage

    Mileage exception

    Member mileage will not be given when purchasing the product of set this setting checked.

    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.

    supplier_code

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

    Supplier code

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

    made_date

    Date of manufacture

    Date of manufacture of the product.

    release_date

    Date of release

    Date of release 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.

    hscode

    HS code

    HS code used for customs duties when shipped overseas. Must enter the correct number for international shipment clearance.

    ※ HScode : The Harmonized Commodity Description and Coding System, also known as the Harmonized System (HS) of tariff nomenclature is an internationally standardized system of names and numbers to classify traded products. It came into effect in 1988 and has since been developed and maintained by the World Customs Organization (WCO) (formerly the Customs Co-operation Council), an independent intergovernmental organization based in Brussels, Belgium, with over 200 member countries.

    product_weight

    Weight of product

    Weight of whole product. Total weight including product, box, and packing weight is necessary for shipping.

    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.

    created_date

    timezone

    Created date

    Date when product registered.

    updated_date

    timezone

    Updated date

    Date when product modified.

    english_product_material

    English product material

    English version of a material of product. When you using an overseas delivery company, you may be required information of a material of the clothes.

    cloth_fabric

    Fabric of product

    In case cloth products using a Japanese courier service, material information may required for some shipping companies.

    woven: Woven
    knit: Knit

    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

    classification_code

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

    Classification code

    Custom classification code for the purpost of self-classification.

    Default : C000000A

    sold_out

    Whether sold out or stock is available

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

    additional_price

    Additional amount of the selling price

    discountprice

    Product discount sale price Entity

    variants

    Variants

    It can be displayed only in detail inquiry.

    memos

    Memos

    It can be displayed only in detail inquiry.

    hits

    Product hits entity

    It can be displayed only in detail inquiry.

    seo

    Product Seo Entity

    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

    country_hscode

    HS code by country

    HS code used for customs duties when shipped overseas. You must enter the correct number for international shipment clearance.
    Since the HS code standard differs from country to country, it is necessary to input the code according to the country.

    It can be displayed only in detail inquiry.

    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

    It can be displayed only in detail inquiry.

    options

    Product Option Entity

    It can be displayed only in detail inquiry.

    shipping_fee_by_product

    Shipping fee by product

    Set whether shipping fee will be charged separately or commonly.
    If this set as FALSE, shipping fee will be charged commonly.

    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_eng

    English name of product

    Product classification information to use for the purpose of overseas customs clearance.

    'clearance category kor' will be automatically translated into English.

    The translated English product name will be sent in the name of the overseas invoice.

    It can be displayed only in detail inquiry.

    clearance_category_kor

    Korean product category for overseas customs clearance

    Product name as Korean

    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.

    image_upload_type

    Image type

    Image type when uploading image.

    The uploaded detail image would resized and set as list image, small list image, reduced image when you set the image as "Representative image"

    The uploaded detail image would neither resized or set as list image, small list image, reduced image when you set the image as "Individual image"

    ※ EC Global can not use C because it does not support FTP

    It can be displayed only in detail inquiry.

    A: Register a representative image.
    B: Register an individual image.
    C: Register through Web FTP.

    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://{mallid}.cafe24api.com/api/v2/admin/products'
    

    Request example:

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

    Response example:

    {
        "products": [
            {
                "shop_no": 1,
                "product_no": 24,
                "product_code": "P000000X",
                "custom_product_code": "",
                "product_name": "iPhone X",
                "eng_product_name": "iPhone Ten",
                "supply_product_name": "iphone A1865 fdd lte",
                "model_name": "A1865",
                "price": "1000.00",
                "retail_price": "0.00",
                "supply_price": "9000.00",
                "display": "T",
                "selling": "F",
                "product_condition": "U",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "margin_rate": "10.00",
                "tax_type": "A",
                "tax_amount": 10,
                "price_content": null,
                "buy_limit_type": "F",
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "except_member_mileage": "F",
                "adult_certification": "F",
                "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
                "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
                "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
                "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
                "has_option": "F",
                "option_type": "T",
                "manufacturer_code": "M0000000",
                "trend_code": "T0000000",
                "brand_code": "B0000000",
                "supplier_code": "S0000000",
                "made_date": "",
                "release_date": "",
                "expiration_date": {
                    "start_date": "20170908",
                    "end_date": "20170914"
                },
                "origin_classification": "F",
                "origin_place_no": 1798,
                "origin_place_value": "",
                "icon_show_period": {
                    "start_date": "2017-10-30 09:00:00",
                    "end_date": "2017-11-02 16:00:00"
                },
                "icon": [
                    "icon_01_01",
                    "icon_02_01"
                ],
                "hscode": "4303101990",
                "product_weight": 1,
                "product_material": "",
                "created_date": "2018-01-18T11:19:27+09:00",
                "updated_date": "2018-01-19T11:19:27+09:00",
                "english_product_material": null,
                "cloth_fabric": null,
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "",
                "classification_code": "C000000A",
                "sold_out": "F",
                "additional_price": "0.00"
            },
            {
                "shop_no": 1,
                "product_no": 23,
                "product_code": "P000000W",
                "custom_product_code": "",
                "product_name": "iPhone X",
                "eng_product_name": "iPhone Ten",
                "supply_product_name": "iphone A1865 fdd lte",
                "model_name": "A1865",
                "price": 1000,
                "retail_price": 0,
                "supply_price": 0,
                "display": "T",
                "selling": "F",
                "product_condition": "U",
                "product_used_month": 2,
                "summary_description": "This is Product Summary.",
                "margin_rate": "10.00",
                "tax_type": "A",
                "tax_amount": 10,
                "price_content": null,
                "buy_limit_type": "F",
                "buy_unit_type": "O",
                "buy_unit": 1,
                "order_quantity_limit_type": "O",
                "minimum_quantity": 1,
                "maximum_quantity": 0,
                "mileage_amount": null,
                "except_member_mileage": "F",
                "adult_certification": "F",
                "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
                "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
                "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
                "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
                "has_option": "F",
                "option_type": "T",
                "manufacturer_code": "M0000000",
                "trend_code": "T0000000",
                "brand_code": "B0000000",
                "supplier_code": "S0000000",
                "made_date": "",
                "release_date": "",
                "expiration_date": {
                    "start_date": "20170908",
                    "end_date": "20170914"
                },
                "origin_classification": "F",
                "origin_place_no": 1798,
                "origin_place_value": "",
                "icon_show_period": {
                    "start_date": "2017-10-30 09:00:00",
                    "end_date": "2017-11-02 16:00:00"
                },
                "icon": [
                    "icon_01_01",
                    "icon_02_01"
                ],
                "hscode": "4303101990",
                "product_weight": 1,
                "product_material": "",
                "created_date": "2018-01-18T11:19:27+09:00",
                "updated_date": "2018-01-19T11:19:27+09:00",
                "english_product_material": null,
                "cloth_fabric": null,
                "list_icon": {
                    "soldout_icon": true,
                    "recommend_icon": false,
                    "new_icon": false
                },
                "approve_status": "C",
                "classification_code": "C000000A",
                "sold_out": "F",
                "additional_price": "0.00"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    discountprice
    embed

    Product discount sale price Entity

    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

    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://{mallid}.cafe24api.com/api/v2/admin/products/count'
    

    Request example:

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

    Response example:

    {
        "count": 2
    }
    

    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

    Get a product

    Definition

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

    Request example:

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

    Response example:

    {
        "product": {
            "shop_no": 1,
            "variants": null,
            "memos": null,
            "hits": null,
            "product_no": 20,
            "category": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "product_code": "P000000T",
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "supply_product_name": "iphone A1865 fdd lte",
            "model_name": "A1865",
            "price": "1000.00",
            "retail_price": "0.00",
            "supply_price": "0.00",
            "display": "T",
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "additional_image": [
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg"
                },
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/e1ab68969d69287a828438c7684b14c4.jpg"
                }
            ],
            "payment_info": "Sample payment info. You have to Pay.",
            "shipping_info": "Sample shipping info. You have to ship.",
            "exchange_info": "Sample exchange info. You have to exchange.",
            "service_info": "Sample service info. You have to service.",
            "meta_title": "",
            "meta_author": "",
            "meta_description": "",
            "meta_keywords": "",
            "meta_alt": "",
            "search_engine_exposure": "T",
            "product_tax_type_text": null,
            "set_product_type": null,
            "country_hscode": {
                "JPN": "430310011",
                "CHN": "43031020"
            },
            "selling": "F",
            "product_condition": "U",
            "product_used_month": 2,
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "product_tag": "edu,test,sample",
            "tags": {
                "tag": [
                    "edu",
                    "test",
                    "sample"
                ]
            },
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "price_content": null,
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "mileage_amount": null,
            "except_member_mileage": "F",
            "adult_certification": "F",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201711\/20_shop1_750339.png",
            "list_image": "http:\/\/{domain}\/web\/product\/medium\/201711\/20_shop1_750339.png",
            "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201711\/20_shop1_750339.png",
            "small_image": "http:\/\/{domain}\/web\/product\/small\/201711\/20_shop1_750339.png",
            "has_option": "F",
            "option_type": "T",
            "manufacturer_code": "M0000000",
            "trend_code": "T0000000",
            "brand_code": "B0000000",
            "supplier_code": "S000000A",
            "made_date": "",
            "release_date": "",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "origin_classification": "F",
            "origin_place_no": 1798,
            "origin_place_value": "",
            "icon_show_period": {
                "start_date": "2017-10-30 09:00:00",
                "end_date": "2017-11-02 16:00:00"
            },
            "icon": null,
            "hscode": "4303101990",
            "product_weight": 1,
            "product_material": "",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "prepaid_shipping_fee": "B",
            "shipping_period": {
                "minimum": 3,
                "maximum": 7
            },
            "shipping_scope": "A",
            "shipping_area": "All around World",
            "shipping_fee_type": "W",
            "shipping_rates": [
                {
                    "shippting_rates_min": "0.00",
                    "shippting_rates_max": "1.00",
                    "shipping_fee": "100.00"
                },
                {
                    "shippting_rates_min": "1.00",
                    "shippting_rates_max": "2.00",
                    "shipping_fee": "200.00"
                }
            ],
            "created_date": "2018-01-18T11:19:27+09:00",
            "updated_date": "2018-01-19T11:19:27+09:00",
            "english_product_material": null,
            "clearance_category_eng": "Necklaces",
            "clearance_category_kor": "주얼리 > 목걸이",
            "clearance_category_code": "ACAB0000",
            "cloth_fabric": null,
            "list_icon": {
                "soldout_icon": true,
                "recommend_icon": true,
                "new_icon": true
            },
            "additional_information": [
                {
                    "key": "custom_option1",
                    "name": "gift option",
                    "value": "Yes"
                }
            ],
            "image_upload_type": "A",
            "classification_code": "C000000A",
            "main": [
                3,
                2
            ],
            "relational_product": [
                {
                    "product_no": 17,
                    "interrelated": "T"
                },
                {
                    "product_no": 19,
                    "interrelated": "F"
                }
            ],
            "select_one_by_option": "F",
            "approve_status": "C",
            "sold_out": "F",
            "additional_price": "0.00"
        }
    }
    

    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

    memos
    embed

    Memos

    hits
    embed

    Product hits entity

    seo
    embed

    Product Seo Entity

    tags
    embed

    Product Tag Entity

    options
    embed

    Product Option Entity

    discountprice
    embed

    Product discount sale price Entity

    Create a product

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "add_category_no": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": 10000,
            "supply_price": 9000,
            "has_option": "T",
            "option": [
                {
                    "name": "Color",
                    "value": [
                        "Red",
                        "Blue",
                        "Green"
                    ]
                },
                {
                    "name": "Size",
                    "value": [
                        "X",
                        "L",
                        "M",
                        "S"
                    ]
                }
            ],
            "image_upload_type": "A",
            "detail_image": "\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "manufacturer_code": "M0000000",
            "supplier_code": "S0000000",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "summary_description": "This is Product Summary.",
            "simple_description": "This is Product Description.",
            "payment_info": "Sample payment info. You have to Pay.",
            "shipping_info": "Sample shipping info. You have to ship.",
            "exchange_info": "Sample exchange info. You have to exchange.",
            "service_info": "Sample service info. You have to service.",
            "hscode": "4303101990",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "shipping_scope": "A",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "clearance_category_code": "ACAB0000",
            "shipping_rates": [
                {
                    "shippting_rates_min": 2000,
                    "shippting_rates_max": 4000,
                    "shipping_fee": 5000
                },
                {
                    "shippting_rates_min": 4000,
                    "shippting_rates_max": 6000,
                    "shipping_fee": 2500
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "prepaid_shipping_fee": "P",
            "origin_classification": "F",
            "origin_place_no": 1798,
            "additional_image": [
                "201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                "201810\/e1ab68969d69287a828438c7684b14c4.jpg"
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": 28,
            "category": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "product_code": "P00000BB",
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": "10000.00",
            "supply_price": "9000.00",
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "payment_info": "Sample payment info. You have to Pay.",
            "shipping_info": "Sample shipping info. You have to ship.",
            "exchange_info": "Sample exchange info. You have to exchange.",
            "service_info": "Sample service info. You have to service.",
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "has_option": "T",
            "manufacturer_code": "M0000000",
            "supplier_code": "S000000A",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "hscode": "4303101990",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_scope": "A",
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shippting_rates_min": "2000.00",
                    "shippting_rates_max": "4000.00",
                    "shipping_fee": "5000.00"
                },
                {
                    "shippting_rates_min": "4000.00",
                    "shippting_rates_max": "6000.00",
                    "shipping_fee": "2500.00"
                }
            ],
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "image_upload_type": "A",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "origin_classification": "F",
            "origin_place_no": 1798,
            "created_date": "2018-05-29T14:23:51+09:00",
            "additional_image": [
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg"
                },
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/e1ab68969d69287a828438c7684b14c4.jpg"
                }
            ]
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    display

    Whether display or not

    Whether display or not.

    T: Display
    F: Do not display

    DEFAULT F

    selling

    Whether selling or not

    Whether selling or not.

    T: Sell
    F: Do not sell

    DEFAULT F

    product_condition

    Product condition

    N: New
    B: Once returned to a seller's warehouse.
    R: Carryover merchandise
    U: Used
    E: Displayed (Condition which already displayed at offline mall or sort of exhibition.)
    F: Refurbished (Condition which products have been previously returned to a manufacturer or vendor for various reasons. This condition includes repaired products from manufacturer. Refurbished products are usually tested by manufacturer or vendor.)
    S: Damaged

    DEFAULT N

    product_used_month

    Max : [2147483647]

    Months of using the used product

    add_category_no

    Category no

    Register your product in the category you want to display using the category number

    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
    Required

    Max Length : [250]

    Product name

    Name of product.

    eng_product_name

    Max Length : [250]

    English name of product

    Name of product in english.

    model_name

    Max Length : [100]

    Model name

    Model name of product.

    price
    Required

    Max : [2147483647]

    Product price

    Price of product.

    supply_price
    Required

    Max : [2147483647]

    Product supply price

    Value of supply. You may calculate price using "supply_price" and "margin_rate". In API, supply_price is used for reference purpose only.

    has_option

    Whether the option is used

    Has an option or not.

    T: use option
    F: do not use option

    DEFAULT F

    option

    Option

    Enter the option name and option value to be modified

    manufacturer_code

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

    Manufacturer code

    Manufacturer code.

    DEFAULT M0000000

    supplier_code

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

    Supplier code

    shipping_fee: shipping

    DEFAULT S0000000

    expiration_date

    Array Max : [2]

    Expiration date

    Expiration date.

    description

    Detail description of product

    Detailed description of product.

    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.

    summary_description

    Max Length : [255]

    Product Summary Description

    shipping_rates_max: Shipping interval end

    simple_description

    Simple Product Description

    If shipping_fee_type is M, D, W, C, you can set the shipping interval by defining the following in the array.

    product_tag

    Max Length : [200]

    Product tag

    Tag for search product.

    payment_info

    Payment info

    Payment method guidance.

    shipping_info

    Shipping info

    Shipping method guidance.

    exchange_info

    Exchange info

    Exchange/return method guidance.

    service_info

    Service info

    Service query / information guidance.

    icon

    Array Max : [5]

    List of icon

    Register icon.

    hscode

    Max Length : [20]

    HS code

    Required if shipping information (shipping_scope) is B (domestic / overseas shipping) or C (overseas shipping)

    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.

    ※ Must required "C" in EC Global shopping mall.

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

    DEFAULT A

    shipping_method

    Shipping method

    Shipping method(when shipping individually).

    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

    DEFAULT 01

    shipping_fee_by_product

    Shipping fee by product

    Shipping charge individually.

    T: Individual delivery
    F: Standard delivery

    DEFAULT F

    shipping_area

    Max Length : [255]

    Shipping area

    Shipping area.

    DEFAULT 전국지역

    shipping_period

    Array Max : [2]

    Shipping period

    Transit time.

    shipping_fee_type

    Shipping charge

    Shipping charge. Type of shipping charge when using 'Shipping charge individually'.

    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

    DEFAULT T

    shipping_rates

    Shipping rates

    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

    prepaid_shipping_fee

    Whether prepaid shipping fee

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

    DEFAULT B

    clearance_category_code

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

    Clearance category code

    Required if shipping information (shipping_scope) is B (domestic / overseas shipping) or C (overseas shipping)

    detail_image

    Detail image

    Detail image.

    list_image

    List image

    List image.

    tiny_image

    Tiny image

    Reduced image.

    small_image

    Reduced image

    shipping_rates_min: Shipping interval start

    image_upload_type

    Image type

    Image type.

    ※ EC Global can not use C because it does not support FTP

    A: Register a representative image.
    B: Register an individual image.
    C: Register through Web FTP.

    DEFAULT A

    additional_information

    Additional information list

    Additional item.

    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

    DEFAULT O

    buy_unit

    Max : [2147483647]

    Minimum unit per purchase

    Unit of order.

    DEFAULT 1

    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

    DEFAULT O

    minimum_quantity

    Max : [2147483647]

    Minimum quantity per purchase

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

    DEFAULT 1

    maximum_quantity

    Max : [2147483647]

    Maximum quantity per purchase

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

    Enter "0" to enter the maximum quantity of orders as "no limit"

    origin_classification

    Origin classification

    Distinguish the origin of a product.

    F: domestic
    T: abroad
    E: other

    DEFAULT F

    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".

    DEFAULT 1798

    origin_place_value

    Max Length : [30]

    Extra information for code of origin

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

    main

    Whether displays at main or not

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

    relational_product

    Related product

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

    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.

    english_product_material

    English product material

    English version of a material of product. When you using an overseas delivery company, you may be required information of a material of the clothes.

    cloth_fabric

    Fabric of product

    In case cloth products using a Japanese courier service, material information may required for some shipping companies.

    woven: Woven
    knit: Knit

    classification_code

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

    Classification code

    additional_price

    Max : [2147483647]

    Additional amount of the selling price

    Additional price is added amount to price in addition to supply price and margin rate. In API, additional price is used only for reperence purpose only.

    margin_rate

    Min : [-999.99]~Max : [999.99]

    Margin rate

    Rate of margin. You may calculate price using "supply_price" and "margin_rate". In API, margin rate is used only for reperence purpose only.

    tax_type

    Taxation category

    Tax type information of product.

    Tax product : VAT, Sales tax, or other tax is included

    Tax free product : Tax free product such as un-processed agriculture products, fishery products, animal products, books, or etc.

    Products for tax free may differ from country to country.

    Zero tax product : Applicable as 0% rate of VAT.

    A: Taxable goods
    B: Duty-free goods
    C: Small goods

    DEFAULT A

    tax_amount

    Min : [0]~Max : [100]

    Tax rate

    Tax rate should be informed for the taxable products.

    Tax rate of products may differ from country to country.

    additional_image

    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.

    Up to 20 'Additional image' can be uploaded.

    Update a product

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "add_category_no": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "delete_category_no": [
                27
            ],
            "custom_product_code": "",
            "product_name": "iPhone X",
            "eng_product_name": "iPhone Ten",
            "model_name": "A1865",
            "price": 10000,
            "supply_price": 9000,
            "has_option": "F",
            "image_upload_type": "A",
            "detail_image": "\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "manufacturer_code": "M0000000",
            "supplier_code": "S0000000",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "buy_limit_type": "F",
            "buy_unit_type": "O",
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "summary_description": "This is Product Summary.",
            "simple_description": "This is Product Description.",
            "payment_info": "Sample payment info. You have to Pay.",
            "shipping_info": "Sample shipping info. You have to ship.",
            "exchange_info": "Sample exchange info. You have to exchange.",
            "service_info": "Sample service info. You have to service.",
            "hscode": "4303101990",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "shipping_scope": "A",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shippting_rates_min": 2000,
                    "shippting_rates_max": 4000,
                    "shipping_fee": 5000
                },
                {
                    "shippting_rates_min": 4000,
                    "shippting_rates_max": 6000,
                    "shipping_fee": 2500
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "origin_classification": "F",
            "origin_place_no": 1798,
            "additional_image": [
                "201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                "201810\/e1ab68969d69287a828438c7684b14c4.jpg"
            ]
        }
    }'
    

    Response example:

    {
        "product": {
            "shop_no": 1,
            "product_no": 7,
            "category": [
                {
                    "category_no": 27,
                    "recommend": "F",
                    "new": "T"
                },
                {
                    "category_no": 28,
                    "recommend": "T",
                    "new": "F"
                }
            ],
            "product_code": "P000000R",
            "custom_product_code": "",
            "product_name": "edu center product",
            "eng_product_name": "education center product",
            "model_name": "sample model",
            "price": "10000.00",
            "supply_price": "9000.00",
            "display": "T",
            "selling": "T",
            "product_condition": "U",
            "product_used_month": 2,
            "buy_unit": 1,
            "order_quantity_limit_type": "O",
            "minimum_quantity": 1,
            "maximum_quantity": 0,
            "description": "Sample Description.",
            "mobile_description": "Sample Mobile Description.",
            "payment_info": "Sample payment info. You have to Pay.",
            "shipping_info": "Sample shipping info. You have to ship.",
            "exchange_info": "Sample exchange info. You have to exchange.",
            "service_info": "Sample service info. You have to service.",
            "simple_description": "This is Product Description.",
            "summary_description": "This is Product Summary.",
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201511\/30_shop1_638611.jpg",
            "has_option": "F",
            "manufacturer_code": "M0000000",
            "supplier_code": "S000000A",
            "expiration_date": {
                "start_date": "20170908",
                "end_date": "20170914"
            },
            "icon": [
                "icon_01_01",
                "icon_02_01"
            ],
            "hscode": "4303101990",
            "shipping_fee_by_product": "T",
            "shipping_method": "01",
            "shipping_period": {
                "minimum": 4,
                "maximum": 10
            },
            "shipping_scope": "A",
            "shipping_area": "All around world",
            "shipping_fee_type": "D",
            "shipping_rates": [
                {
                    "shippting_rates_min": "2000.00",
                    "shippting_rates_max": "4000.00",
                    "shipping_fee": "5000.00"
                },
                {
                    "shippting_rates_min": "4000.00",
                    "shippting_rates_max": "6000.00",
                    "shipping_fee": "2500.00"
                }
            ],
            "prepaid_shipping_fee": "P",
            "clearance_category_code": "ACAB0000",
            "image_upload_type": "A",
            "relational_product": [
                {
                    "product_no": 9,
                    "interrelated": "T"
                },
                {
                    "product_no": 10,
                    "interrelated": "F"
                }
            ],
            "product_material": "Aluminum",
            "english_product_material": "Aluminum",
            "cloth_fabric": "knit",
            "classification_code": "C000000A",
            "additional_price": "1100.00",
            "margin_rate": "10.00",
            "tax_type": "A",
            "tax_amount": 10,
            "origin_classification": "F",
            "origin_place_no": 1798,
            "updated_date": "2018-05-29T14:23:51+09:00",
            "translated_additional_description": "This is a translated additional description of product.",
            "translated": "T",
            "additional_image": [
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/a2803c44ee8299486ff19be239cef7d0.jpg"
                },
                {
                    "big": "http:\/\/{domain}\/web\/product\/extra\/big\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "medium": "http:\/\/{domain}\/web\/product\/extra\/medium\/201810\/e1ab68969d69287a828438c7684b14c4.jpg",
                    "small": "http:\/\/{domain}\/web\/product\/extra\/small\/201810\/e1ab68969d69287a828438c7684b14c4.jpg"
                }
            ]
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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.

    display

    Whether display or not

    You can choose product should be displayed or not.

    T: Display
    F: Do not display

    selling

    Whether selling or not

    Whether selling or not.

    T: Sell
    F: Do not sell

    product_condition

    Product condition

    N: New
    B: Once returned to a seller's warehouse.
    R: Carryover merchandise
    U: Used
    E: Displayed (Condition which already displayed at offline mall or sort of exhibition.)
    F: Refurbished (Condition which products have been previously returned to a manufacturer or vendor for various reasons. This condition includes repaired products from manufacturer. Refurbished products are usually tested by manufacturer or vendor.)
    S: Damaged

    product_used_month

    Max : [2147483647]

    Months of using the used product

    add_category_no

    Category no

    Enter a category number to add a specific product category to the product

    delete_category_no

    Deleted classification number

    Enter a category number to delete a specific product category to the product

    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.

    eng_product_name

    Max Length : [250]

    English name of product

    Name of product in english.

    model_name

    Max Length : [100]

    Model name

    Model name of product.

    price

    Max : [2147483647]

    Product price

    Price of product.

    supply_price

    Max : [2147483647]

    Product supply price

    Value of supply. You may calculate price using "supply_price" and "margin_rate". In API, supply_price is used for reference purpose only.

    has_option

    Whether the option is used

    Has an option or not.

    F: Option not used

    manufacturer_code

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

    Manufacturer code

    Manufacturer code.

    supplier_code

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

    Supplier code

    Supplier code.

    expiration_date

    Array Max : [2]

    Expiration date

    Expiration date.

    description

    Detail description of product

    Detailed description of product.

    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.

    summary_description

    Max Length : [255]

    Product Summary Description

    Summary description of product.

    simple_description

    Simple Product Description

    Simple description of product.

    product_tag

    Max Length : [200]

    Product tag

    Tag for search product.

    payment_info

    Payment info

    Payment method guidance.

    shipping_info

    Shipping info

    Shipping method guidance.

    exchange_info

    Exchange info

    Exchange/return method guidance.

    service_info

    Service info

    Service query / information guidance.

    icon

    Array Max : [5]

    List of icon

    Register icon.

    hscode

    Max Length : [20]

    HS code

    Required if shipping information (shipping_scope) is B (domestic / overseas shipping) or C (overseas shipping)

    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.

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

    shipping_method

    Shipping method

    Shipping method(when shipping individually).

    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

    shipping_fee_by_product

    Shipping fee by product

    Shipping charge individually.

    T: Individual delivery
    F: Standard delivery

    shipping_area

    Max Length : [255]

    Shipping area

    Shipping area.

    shipping_period

    Array Max : [2]

    Shipping period

    Transit time.

    shipping_fee_type

    Shipping charge

    Shipping charge. Type of shipping charge when using 'Shipping charge individually'.

    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

    Shipping rates

    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

    prepaid_shipping_fee

    Whether prepaid shipping fee

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

    clearance_category_code

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

    Clearance category code

    Required if shipping information (shipping_scope) is B (domestic / overseas shipping) or C (overseas shipping)

    detail_image

    Detail image

    Detail image.

    list_image

    List image

    List image.

    tiny_image

    Tiny image

    Reduced image.

    small_image

    Reduced image

    Small list image.

    image_upload_type

    Image type

    Image type.

    ※ EC Global can not use C because it does not support FTP

    A: Register a representative image.
    B: Register an individual image.
    C: Register through Web FTP.

    additional_information

    Additional information list

    Additional item.

    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

    Max : [2147483647]

    Minimum unit per purchase

    Unit of order.

    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.

    If you modify the minimum quantity per purchase, you must modify the maximum order quantity together.

    maximum_quantity

    Max : [2147483647]

    Maximum quantity per purchase

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

    If you modify the minimum quantity per purchase, you must modify the maximum order quantity together.

    Enter "0" to enter the maximum quantity of orders as "no limit"

    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

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

    main

    Whether displays at main or not

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

    relational_product

    Related product

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

    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.

    english_product_material

    English product material

    English version of a material of product. When you using an overseas delivery company, you may be required information of a material of the clothes.

    cloth_fabric

    Fabric of product

    In case cloth products using a Japanese courier service, material information may required for some shipping companies.

    woven: Woven
    knit: Knit

    classification_code

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

    Classification code

    additional_price

    Max : [2147483647]

    Additional amount of the selling price

    Additional price is added amount to price in addition to supply price and margin rate. In API, additional price is used only for reperence purpose only.

    margin_rate

    Min : [-999.99]~Max : [999.99]

    Margin rate

    Rate of margin. You may calculate price using "supply_price" and "margin_rate". In API, margin rate is used only for reperence purpose only.

    tax_type

    Taxation category

    Tax type information of product.

    Tax product : VAT, Sales tax, or other tax is included

    Tax free product : Tax free product such as un-processed agriculture products, fishery products, animal products, books, or etc.

    Products for tax free may differ from country to country.

    Zero tax product : Applicable as 0% rate of VAT.

    A: Taxable goods
    B: Duty-free goods
    C: Small goods

    tax_amount

    Min : [0]~Max : [100]

    Tax rate

    Tax rate should be informed for the taxable products.

    Tax rate of products may differ from country to country.

    additional_image

    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.

    Up to 20 'Additional image' can be uploaded.

    Delete a product

    Definition

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

    Request example:

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

    Response example:

    {
        "product": {
            "product_no": 28
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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 approve

    API which can only be used when mall using products approval function.

    Products approve properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    status

    Approval status

    Approval status of the product requested.

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

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Create a products approve

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/approve' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "user_id": "supplytwo"
        }
    }'
    

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "N",
            "product_no": "7"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    user_id
    Required

    Supplier operator ID

    ID of supplier operator who requested

    Update a products approve

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/7/approve' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "user_id": "supplytwo",
            "status": "C"
        }
    }'
    

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "C",
            "product_no": "7"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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.

    user_id
    Required

    Supplier operator ID

    ID of supplier operator who requested

    status
    Required

    Approval status

    Approval status of the product requested.

    C: Approved status
    R: Rejected status
    I: Checking status

    Get products approve status

    Definition

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

    Request example:

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

    Response example:

    {
        "approve": {
            "shop_no": 1,
            "status": "C",
            "product_no": "7"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    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://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/cart/count'
    

    Request example:

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

    Response example:

    {
        "count": 7
    }
    

    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 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://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/discountprice'
    

    Request example:

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

    Response example:

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

    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://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/hits/count'
    

    Request example:

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

    Response example:

    {
        "count": 3
    }
    

    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 icons

    A product icon is a small image that you can add next to an item to emphasize it. You can emphasize items by adding messages such as discount information, "close to sold out" on the displayed products.
    The item icon can only be used in the Products subset as a embedded Entity.

    Products icons properties

    Attribute Description
    code

    Code

    Code of Icon.

    path

    Path

    URL of Icon.

    List all products icons

    Definition

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

    Request example:

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

    Response example:

    {
        "icons": [
            {
                "code": "icon_01_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_01_01.gif"
            },
            {
                "code": "icon_02_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_02_01.gif"
            },
            {
                "code": "icon_05_01",
                "path": "\/\/img.echosting.cafe24.com\/icon\/product\/ko_KR\/icon_05_01.gif"
            },
            {
                "code": "custom_1",
                "path": "\/web\/upload\/\/custom_1.gif"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Products images

    Products Images means the pictures or pictures of the products uploaded for sale. Use the Product Image API to upload an image for use in a product description, or upload an image of a product.
    Images of the products can be uploaded by encoding to Base64 code.

    Products images properties

    Attribute Description
    path

    Detail image

    Detailed image.

    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.

    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.

    Upload a image

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/images' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "image": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAXSURBVChTY1BQdvhPDB5ViBdTW6HDfwA+dpbJG+7kLwAAAABJRU5ErkJggg==\n"
        }
    }'
    

    Response example:

    {
        "image": {
            "path": "http:\/\/{domain}\/web\/upload\/NNEditor\/20180130\/12ecf27747401c8502ddd6b2e79e1e64.png"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    image
    Required

    Detail image

    Detail image' showing on the product detail page.

    Upload product images

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/images' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "image_upload_type": "B",
            "detail_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "list_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "tiny_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=",
            "small_image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX\/TQBcNTh\/AAAAAXRSTlPM0jRW\/QAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII="
        }
    }'
    

    Response example:

    {
        "image": {
            "shop_no": 1,
            "product_no": 20,
            "detail_image": "http:\/\/{domain}\/web\/product\/big\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "list_image": "http:\/\/{domain}\/web\/product\/medium\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "tiny_image": "http:\/\/{domain}\/web\/product\/tiny\/201801\/995feab7d359875e073ae82b48192a7b.jpeg",
            "small_image": "http:\/\/{domain}\/web\/product\/small\/201801\/995feab7d359875e073ae82b48192a7b.jpeg"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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.

    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

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

    small_image

    Reduced image

    Small list image' showing on the recently viewed page.

    image_upload_type
    Required

    Image type

    You can specify the upload type, whether the image type is representative image or individual image. If you select the representative image (A), uploading the image to the detail image (detail_image) will be reflected in all other images.

    A: Register a representative image.
    B: Register an individual image.

    Delete a products image

    Definition

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

    Request example:

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

    Response example:

    {
        "image": {
            "product_no": 20
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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 memos

    Products Memos is a brief note that can be used as a tool for memorizing special items or communicating with operators.
    Products Memos can only be used in the Products subset as a embedded Entity.

    Products memos properties

    Attribute Description
    memo_no

    Memo number

    System assigned code. This code cannot be duplicated.

    author_id

    Max Length : [20]

    Author ID

    ID of memo writer.

    created_date

    timezone

    Created date

    Written date of memo.

    memo

    Important memo

    Contents of memo. You may input this with HTML..

    List all products memos

    Definition

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

    Request example:

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

    Response example:

    {
        "memos": [
            {
                "memo_no": 4,
                "author_id": "subadmin1",
                "created_date": "2018-01-18T11:19:27+09:00",
                "memo": "This is a sample memo."
            },
            {
                "memo_no": 3,
                "author_id": "subadmin2",
                "created_date": "2018-01-18T11:19:27+09:00",
                "memo": "This is a sample memo."
            }
        ]
    }
    

    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.

    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.

    Get a products memo

    Definition

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

    Request example:

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

    Response example:

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

    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.

    memo_no
    Required

    Memo number

    System assigned code. This code cannot be duplicated.

    Create a products memo

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    author_id
    Required

    Max Length : [20]

    Author ID

    ID of memo writer.

    memo
    Required

    Important memo

    Contents of memo. You may input this with HTML..

    Update a products memo

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/memos/7' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "author_id": "subadmin2",
            "memo": "Curabitur mollis consequat ipsum ac."
        }
    }'
    

    Response example:

    {
        "memo": {
            "memo_no": 7,
            "author_id": "subadmin2",
            "created_date": "2018-01-18T11:19:27+09:00",
            "memo": "Curabitur mollis consequat ipsum ac."
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    memo_no
    Required

    Memo number

    System assigned code. This code cannot be duplicated.

    author_id
    Required

    Max Length : [20]

    Author ID

    ID of memo writer.

    memo
    Required

    Important memo

    Contents of memo. You may input this with HTML..

    Delete a products memo

    Definition

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

    Request example:

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

    Response example:

    {
        "memo": {
            "memo_no": 12
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    memo_no
    Required

    Memo number

    System assigned code. This code cannot be duplicated.

    Products options

    Products options properties

    Attribute Description
    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    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_preset_code

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

    Option set code

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

    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

    option_preset_name

    Option preset name

    If you use "linked with product" option, show the name of the option set

    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

    Create a products option

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "has_option": "T",
            "option_type": "T",
            "option_list_type": "S",
            "option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                }
            ],
            "use_additional_option": "T",
            "additional_option": [
                {
                    "additional_option_name": "Pattern",
                    "required_additional_option": "T",
                    "additional_option_text_length": 20
                },
                {
                    "additional_option_name": "Custom Option",
                    "required_additional_option": "F",
                    "additional_option_text_length": 10
                }
            ],
            "use_attached_file_option": "T",
            "attached_file_option": {
                "option_name": "Pattern Images",
                "required": "T",
                "size_limit": 3
            }
        }
    }'
    

    Response example:

    {
        "option": {
            "shop_no": 1,
            "product_no": 24,
            "has_option": "T",
            "option_type": "T",
            "option_list_type": "S",
            "option_preset_code": "",
            "option": [
                {
                    "option_code": "",
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black",
                            "option_image_file": "",
                            "option_color": "",
                            "value_no": null
                        },
                        {
                            "option_text": "Red",
                            "option_image_file": "",
                            "option_color": "",
                            "value_no": null
                        }
                    ],
                    "required_option": "T",
                    "option_display_type": "S"
                }
            ],
            "select_one_by_option": "F",
            "option_preset_name": "",
            "use_additional_option": "T",
            "additional_option": [
                {
                    "additional_option_name": "Pattern",
                    "required_additional_option": "T",
                    "additional_option_text_length": 20
                },
                {
                    "additional_option_name": "Custom Option",
                    "required_additional_option": "F",
                    "additional_option_text_length": 10
                }
            ],
            "use_attached_file_option": "T",
            "attached_file_option": {
                "option_name": "Pattern Images",
                "required": "T",
                "size_limit": 3
            }
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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.

    has_option

    Whether the option is used

    T: Use
    F: Do not use

    option_type

    Type of option

    Enter 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, enter 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.

    S: Combination separation option
    C: Combination integration option

    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: Used
    F: Not used; Existed only in the independent type; Process the selected value by option if being checked.

    option_preset_name

    Option preset name

    If you use "linked with product" option, enter the name of the option set

    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

    Update a products option

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/24/options' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "option_list_type": "S",
            "original_option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                },
                {
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_text": "Small"
                        },
                        {
                            "option_text": "Large"
                        }
                    ]
                }
            ],
            "option": [
                {
                    "option_name": "Color",
                    "option_value": [
                        {
                            "option_text": "Black"
                        },
                        {
                            "option_text": "Red"
                        }
                    ]
                },
                {
                    "option_name": "Size",
                    "option_value": [
                        {
                            "option_text": "Small"
                        },
                        {
                            "option_text": "Large"
                        }
                    ]
                }
            ],
            "use_additional_option": "T",
            "additional_option": [
                {
                    "additional_option_name": "Pattern",
                    "required_additional_option": "T",
                    "additional_option_text_length": 20
                },
                {
                    "additional_option_name": "Custom Option",
                    "required_additional_option": "F",
                    "additional_option_text_length": 10
                }
            ],
            "use_attached_file_option": "T",
            "attached_file_option": {
                "option_name": "Pattern Images",
                "required": "T",
                "size_limit": 3
            }
        }
    }'
    

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_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.

    option_list_type

    Option list type

    If you use the combined option, enter 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.

    S: Combination separation option
    C: Combination integration option

    option_preset_code

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

    Option set code

    If you use the linked with product option, enter the option preset code.

    option

    Option

    Enter the option name and option value to be modified

    original_option

    Option value before modification

    Enter the original option name and option value to be modified. The field must contain the existing option name and option value to be modified. The options entered in "original_option" are updated with the option names and option values entered in "option".

    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: Used
    F: Not used; Existed only in the independent type; Process the selected value by option if being checked.

    option_preset_name

    Option preset name

    If you use "linked with product" option, enter the name of the option set

    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

    Delete a products option

    Definition

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

    Request example:

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

    Response example:

    {
        "option": {
            "product_no": 24
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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.

    List all products option

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    Products seo

    Products SEO stands for Search Engine Optimization, which allows SEO APIs to better search for products or shopping malls in search engines.
    As a e,beded entity of the product, the Products SEO API can set search engine optimization of the target product.

    Products seo properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    meta_title

    Browser title

    Information displayed at product's detail page. Title tag is the most basic information for search which displays at browser.

    meta_author

    Meta tag 1: Author

    Information displayed at tag in product's detail page. You may input the person who manufactured or registered the product.

    meta_description

    Meta tag 2: Description

    Information displayed at tag in product detail page. You may input the information which displays at the search result.

    meta_keywords

    Meta tag 3: Keywords

    Information displayed at tag in product detail page. You may input keywords that want to be searched.

    meta_alt

    Alt text of product image

    Alt text of product image. Image has a better change to be searched if the image has alt text. Browser can shows alt text instead of image which is advantageous for web accessibility.

    search_engine_exposure

    Set the exposure to search engine

    Either expose a product at search engine or not. If this set as FALSE, the product will not exposed at search engine.

    T: Use
    F: Do not use

    Get products seo

    Definition

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

    Request example:

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

    Response example:

    {
        "seo": {
            "shop_no": 1,
            "meta_title": "product title",
            "meta_author": "This is Author",
            "meta_description": "This is Description.",
            "meta_keywords": "This is Keyword.",
            "meta_alt": "image1, image2",
            "search_engine_exposure": "T"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Update a products seo

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/seo' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "meta_title": "Updated title",
            "meta_author": "Updated Author",
            "meta_description": "Updated Description",
            "meta_keywords": "Updated Keywords",
            "meta_alt": "Upadted Alt Text",
            "search_engine_exposure": "T"
        }
    }'
    

    Response example:

    {
        "seo": {
            "shop_no": 1,
            "meta_title": "Updated title",
            "meta_author": "Updated Author",
            "meta_description": "Updated Description",
            "meta_keywords": "Updated Keywords",
            "meta_alt": "Upadted Alt Text",
            "search_engine_exposure": "T"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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.

    meta_title

    Browser title

    Information displayed at product's detail page. Title tag is the most basic information for search which displays at browser.

    meta_author

    Meta tag 1: Author

    Information displayed at tag in product's detail page. You may input the person who manufactured or registered the product.

    meta_description

    Meta tag 2: Description

    Information displayed at tag in product detail page. You may input the information which displays at the search result.

    meta_keywords

    Meta tag 3: Keywords

    Information displayed at tag in product detail page. You may input keywords that want to be searched.

    meta_alt

    Alt text of product image

    Alt text of product image. Image has a better change to be searched if the image has alt text. Browser can shows alt text instead of image which is advantageous for web accessibility.

    search_engine_exposure

    Set the exposure to search engine

    Either expose a product at search engine or not. If this set as FALSE, the product will not exposed at search engine.

    Products tags

    Products tags 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.

    tag

    Product tag

    Tag or keyword for product searching.

    Create a products tag

    Definition

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

    Request example:

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

    Response example:

    {
        "tag": {
            "shop_no": 1,
            "product_no": 7,
            "tag": [
                "Tag1",
                "Tag2"
            ]
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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.

    tag
    Required

    Product tag

    Tag or keyword for product searching.

    List all products tags

    Definition

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

    Request example:

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

    Response example:

    {
        "tags": {
            "shop_no": 1,
            "tag": [
                "Tag1",
                "Tag2"
            ]
        }
    }
    

    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.

    Count all products tags

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 3
    }
    

    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.

    Delete a products tag

    Definition

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

    Request example:

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

    Response example:

    {
        "tag": {
            "product_no": 7,
            "tag": "Tag1"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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.

    tag

    Product tag

    Tag or keyword for product searching.

    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.

    custom_variant_code

    Max Length : [40]

    Custom variants code

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

    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: Sell
    F: Do not sell

    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: Display
    F: Do not display

    additional_amount

    Additional price

    Additional price for purchase the variants.

    inventories

    Inventories

    Inventory Entity of variants.

    duplicated_custom_variant_code

    Whether duplicate custom variant code

    T: Duplicated
    F: Not duplicated

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    List all products variants

    Definition

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

    Request example:

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

    Response example:

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

    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://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants/{#id}'
    

    Request example:

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

    Response example:

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

    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

    Inventory Entity. You can get with inventory(stock) information using Embed parameter.

    Update a products variant

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/16/variants/P000000P000A' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "custom_variant_code": "OPTION_CUSTOM_CODE",
            "display": "T",
            "selling": "F",
            "additional_amount": -1000,
            "quantity": 15,
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "B",
            "display_soldout": "T"
        }
    }'
    

    Response example:

    {
        "variant": {
            "shop_no": 1,
            "variant_code": "P000000R000A",
            "option": [
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "custom_variant_code": "OPTION_CUSTOM_CODE",
            "duplicated_custom_variant_code": "F",
            "display": "T",
            "selling": "F",
            "additional_amount": -1000,
            "inventories": {
                "shop_no": 1,
                "variant_code": "P000000R000A",
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "B",
                "display_soldout": "T"
            }
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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]

    Product item code

    System assigned code. This code cannot be duplicated.

    custom_variant_code

    Max Length : [40]

    Custom variants code

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

    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.

    quantity

    Available inventory

    use_inventory

    Whether use inventory or not

    T: Use
    F: Do not use

    important_inventory

    Whether it is an important inventory

    A: General inventory
    B: Important inventory

    inventory_control_type

    Inventory check criteria

    A: Based on order
    B: Based on payment

    display_soldout

    Whether to display sold-out or not

    T: Out-of-stock displayed
    F: Out-of-stock not displayed

    Delete a products variant

    Definition

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

    Request example:

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

    Response example:

    {
        "variant": {
            "product_no": 16,
            "variant_code": "P000000P000A"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    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]

    Product item code

    System assigned code. This code cannot be duplicated.

    Update products variants

    It is an variants update API which can modify several items of one product at a time.

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/16/variants' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": [
            {
                "variant_code": "P000000P000B",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "A",
                "display_soldout": "T"
            },
            {
                "variant_code": "P000000P000C",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "quantity": 15,
                "use_inventory": "T",
                "important_inventory": "A",
                "inventory_control_type": "A",
                "display_soldout": "T"
            }
        ]
    }'
    

    Response example:

    {
        "variants": [
            {
                "shop_no": 1,
                "variant_code": "P000000P000B",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "option": [
                    {
                        "name": "Color",
                        "value": "Black"
                    }
                ],
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "inventories": {
                    "shop_no": 1,
                    "variant_code": "P000000P000B",
                    "quantity": 15,
                    "use_inventory": "T",
                    "important_inventory": "A",
                    "inventory_control_type": "B",
                    "display_soldout": "T"
                }
            },
            {
                "shop_no": 1,
                "variant_code": "P000000P000C",
                "custom_variant_code": "OPTION_CUSTOM_CODE",
                "option": [
                    {
                        "name": "Color",
                        "value": "Red"
                    }
                ],
                "display": "T",
                "selling": "F",
                "additional_amount": -1000,
                "inventories": {
                    "shop_no": 1,
                    "variant_code": "P000000P000B",
                    "quantity": 15,
                    "use_inventory": "T",
                    "important_inventory": "A",
                    "inventory_control_type": "B",
                    "display_soldout": "T"
                }
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE WRITE_PRODUCT
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    variant_code
    Required

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

    Product item code

    custom_variant_code

    Max Length : [40]

    Custom variants code

    display

    Whether display or not

    T: Display
    F: Do not display

    selling

    Whether selling or not

    T: Sell
    F: Do not sell

    additional_amount

    Additional price

    quantity

    Available inventory

    use_inventory

    Whether use inventory or not

    T: Use
    F: Do not use

    important_inventory

    Whether it is an important inventory

    A: General inventory
    B: Important inventory

    inventory_control_type

    Inventory check criteria

    A: Based on order
    B: Based on payment

    display_soldout

    Whether to display sold-out or not

    T: Out-of-stock displayed
    F: Out-of-stock not displayed

    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.

    use_inventory

    Whether use inventory or not

    Whether use inventory management or not at the variants. You may input inventory when using inventory management option. If the set as FALSE, you may sell product regardless of inventory and cannot use 'Available inventory', 'Inventory check criteria', 'Soldout display' attributes.

    T: Use
    F: Do not use

    important_inventory

    Whether it is an important inventory

    Whether the inventory is important or not. Mall can use this information as a data for search.

    A: General inventory
    B: Important inventory

    inventory_control_type

    Inventory check criteria

    Decide when the inventory will be deducted. You may set inventory deduction criteria differently.

    Order criteria : Inventory deducted when order made. When customer choose to pay with account transfer, the inventory deducted before money transferred.
    Payment criteria : Inventory deducted when payment made. When customer choose to pay with account transfer, the inventory deducted after money transferred.

    A: Based on order
    B: Based on payment

    display_soldout

    Whether to display sold-out or not

    Whether display 'Sold out' when if the product use the inventory option. If this set as TRUE(display sold-out), customer cannot purchase the product after displayed as 'Sold out'. 'Sold out' icon will be displayed on the product after every variants being sold out.
    If this set as FALSE(do not display sold-out), customer can purchase the product and inventory will be shown as negative(-).

    T: Out-of-stock displayed
    F: Out-of-stock not displayed

    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://{mallid}.cafe24api.com/api/v2/admin/products/{#id}/variants/{#id}/inventories'
    

    Request example:

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

    Response example:

    {
        "inventory": {
            "shop_no": 1,
            "variant_code": "P000000R000C",
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "B",
            "display_soldout": "F",
            "quantity": 0
        }
    }
    

    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.

    Update a products variants inventory

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/products/20/variants/P00000GR000A/inventories' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "A",
            "display_soldout": "T",
            "quantity": 3
        }
    }'
    

    Response example:

    {
        "inventory": {
            "shop_no": 1,
            "variant_code": "P00000GR000A",
            "use_inventory": "T",
            "important_inventory": "A",
            "inventory_control_type": "A",
            "display_soldout": "T",
            "quantity": 3
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_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

    System assigned code. This code cannot be duplicated.

    use_inventory

    Whether use inventory or not

    Whether use inventory management or not at the variants. You may input inventory when using inventory management option. If the set as FALSE, you may sell product regardless of inventory and cannot use 'Available inventory', 'Inventory check criteria', 'Soldout display' attributes.

    T: Use
    F: Do not use

    important_inventory

    Whether it is an important inventory

    Whether the inventory is important or not. Mall can use this information as a data for search.

    A: General inventory
    B: Important inventory

    inventory_control_type

    Inventory check criteria

    Decide when the inventory will be deducted. You may set inventory deduction criteria differently.

    Order criteria : Inventory deducted when order made. When customer choose to pay with account transfer, the inventory deducted before money transferred.
    Payment criteria : Inventory deducted when payment made. When customer choose to pay with account transfer, the inventory deducted after money transferred.

    A: Based on order
    B: Based on payment

    display_soldout

    Whether to display sold-out or not

    Whether display 'Sold out' when if the product use the inventory option. If this set as TRUE(display sold-out), customer cannot purchase the product after displayed as 'Sold out'. 'Sold out' icon will be displayed on the product after every variants being sold out.
    If this set as FALSE(do not display sold-out), customer can purchase the product and inventory will be shown as negative(-).

    T: Out-of-stock displayed
    F: Out-of-stock not displayed

    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.

    Reports salesvolume

    SalesVolume is the quantity of goods sold in the shopping mall. The sales quantity is updated periodically, so it may not be reflected in real time.

    Reports salesvolume properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    collection_date

    Settlement collection date

    Collection date on which sales volume statistics were collected

    collection_hour

    Settlement collection time

    Collection time when sales volume statistics were collected

    product_price

    Product price

    Price of the product.

    product_option_price

    Product option price

    Additional price for option.

    settle_count

    Quantity completely paid

    Count for payment complete order at search period.

    exchane_product_count

    Quantity of products completely exchanged

    Quantity exchanged for the item during the searched period.

    cancel_product_count

    Quantity completely cancelled

    Count canceled product withint search period.

    return_product_count

    Quantity of products completely returned

    Count returned product at search period.

    updated_date

    timezone

    Final data renewal time

    Shows time when sales quantity statistical data is updated.

    variants_code

    Variant code

    Variants code of the product.

    product_no

    Product number

    total_sales

    Total sales volume

    Total quantity sold during the time period that the item was searched.

    Get sales volume

    Definition

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

    Request example:

    curl -X GET \
      'https://{mallid}.cafe24api.com/api/v2/admin/reports/salesvolume?variants_code=P0000BKE000A&product_no=16&start_date=2018-10-27 14:10:00&end_date=2018-10-28 14:10:59' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' 
    

    Response example:

    {
        "salesvolume": [
            {
                "shop_no": "1",
                "collection_date": "2018-10-27",
                "collection_hour": "12",
                "product_price": "10000.00",
                "product_option_price": "0.00",
                "settle_count": "2",
                "exchane_product_count": "0",
                "cancel_product_count": "0",
                "return_product_count": "0",
                "updated_date": "2018-10-27T14:51+09:00",
                "product_no": 16,
                "variants_code": "P0000BKE000A",
                "change_cancel_product_count": "0",
                "total_sales": "2"
            },
            {
                "shop_no": "1",
                "collection_date": "2018-10-27",
                "collection_hour": "12",
                "product_price": "10000.00",
                "product_option_price": "0.00",
                "settle_count": "23",
                "exchane_product_count": "0",
                "cancel_product_count": "0",
                "return_product_count": "0",
                "updated_date": "2018-10-27T14:51+09:00",
                "product_no": 16,
                "variants_code": "P0000BKE000B",
                "change_cancel_product_count": "0",
                "total_sales": "23"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_SALESREPORT
    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

    System assigned code. This code cannot be duplicated.

    You can search multiple item with ,(comma)

    variants_code

    Variant code

    Variants code for search sales volume.

    category_no

    Category number

    Count sales volume of specific category.

    mobile

    Whether it is mobile or PC

    Count sales volume at mobile.

    T: Mobile
    F: Others

    delivery_type

    Delivery type

    Count sales volume of either domestic or abroad.

    A: Domestic
    B: Overseas

    customer_group_no

    Member level number

    Count sales volume of specific customer group.

    supplier_id

    Max Length : [20]

    Supplier id

    Search for quantity registered with specific supplier ID among sales quantity.

    start_date
    Required

    Date
    timezone

    Search Start Date

    Search start date for count sales volume(by order date).
    Must use with 'updated end date' simultaneously.

    end_date
    Required

    Date
    timezone

    Search End Date

    End date of search for sales volume(by order date).
    Must use with 'start_date' simultaneously.

    Reviews

    Reviews is reviews written by customers in a shopping mall after using a product or service. To use the Reviews API, you first need to make sure that shopping mall using the Reviewtalk service in the shopping mall.

    Reviews properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    product_no

    상품번호

    review_no

    리뷰 번호

    order_id

    Order ID

    주문 번호

    order number

    nickname

    작성자 별명

    title

    리뷰 제목

    content

    리뷰 내용

    content_text_length

    리뷰글 텍스트 길이

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    writer

    작성자명

    writing_id

    작성자 회원 아이디

    created_date

    Date
    timezone

    작성일자

    comment_count

    댓글 갯수

    like_count

    Min : [0]

    좋아요 횟수

    share_count

    Min : [0]

    SNS 공유 횟수

    hit_count

    Min : [0]

    조회수

    additional_information

    추가 항목

    images

    첨부 이미지

    Image that attached at review.

    tags

    해시태그

    rating

    평점

    Rating of review.

    use_share

    SNS 공유 여부

    Whether share review to SNS.

    T : 공유함
    F : 공유안함

    display

    게시 여부

    Whether display or not.

    T : 게시함
    F : 게시안함

    deleted

    삭제 여부

    Whether deleted or not.

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

    Create a review

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "writing_id": "user",
            "input_channel": "P",
            "content": "#recommend #popular product.",
            "item_code": "P000000J000A",
            "images": [
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/20\/6660b56b72d3633c83744eb4d4b53209.PNG",
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/26\/c5fd9f37eab7a37eb4aed1f0ee38879e.jpg"
            ],
            "additional_information": [
                "170~180",
                "95"
            ],
            "order_id": "20180116-0000026",
            "use_share": "F",
            "product_no": 10,
            "rating": "4.0",
            "tags": [
                "recommend",
                "popular"
            ]
        }
    }'
    

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    writing_id
    Required

    작성자 회원 아이디

    Member ID of review writer.

    product_no
    Required

    상품번호

    System assigned code. This code cannot be duplicated.

    order_id

    Order ID

    주문번호

    Order number.

    item_code
    Required

    품목코드

    Product Item code for a review.

    content
    Required

    Max Length : [2000]

    리뷰 내용

    Content of review.

    rating

    평점

    Rating of review.

    DEFAULT 5

    additional_information

    추가항목

    images

    첨부 이미지

    Image that attached at review.

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    DEFAULT P

    use_share

    SNS 공유 여부

    Whether share review to SNS.

    T : 공유함
    F : 공유안함

    List all reviews

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no

    리뷰 번호

    writing_id

    작성자 회원 아이디

    member ID

    created_start_date

    Date
    timezone

    작성일 검색 시작일

    Search for reviews that created after certain date.

    created_end_date

    Date
    timezone

    작성일 검색 종료일

    Search for reviews that created before certain date.

    deleted

    삭제된 리뷰글 여부

    Whether review is deleted or not.

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

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    Search for reviews that has comment.

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

    has_image

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

    Search for reviews that has image attachment.

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

    search_key

    검색 대상 항목

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

    keyword

    검색어

    mileage

    적립금 지급 여부

    Whether mileage is provided or not.

    todo : 지급안함
    done : 지급함

    limit

    Min : [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    Min : [0]

    목록을 가져올 시작 위치

    Set the start location of search result.

    Get a review

    Definition

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

    Request example:

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

    Response example:

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

    Specification

    Property Description
    SCOPE READ_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    Count all reviews

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 2
    }
    

    Specification

    Property Description
    SCOPE READ_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    writing_id

    작성자 회원 아이디

    member ID

    created_start_date

    Date
    timezone

    작성일 검색 시작일

    Search for reviews that created after certain date.

    created_end_date

    Date
    timezone

    작성일 검색 종료일

    Search for reviews that created before certain date.

    deleted

    삭제된 리뷰글 여부

    Whether review is deleted or not.

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

    DEFAULT F

    input_channel

    리뷰글 작성 경로

    P : PC
    M : 모바일

    has_comment

    댓글이 작성된 리뷰만 검색

    Search for reviews that has comment.

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

    has_image

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

    Search for reviews that has image attachment.

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

    search_key

    검색 대상 항목

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

    keyword

    검색어

    mileage

    적립금 지급 여부

    todo : 지급안함
    done : 지급함

    Update a review

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/{#id}' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "content": "#cool #best product review.",
            "rating": "3.0",
            "images": [
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/20\/6660b56b72d3633c83744eb4d4b53209.PNG",
                "https:\/\/reviewtalktalk.poxo.com\/sampleid\/2016\/10\/26\/c5fd9f37eab7a37eb4aed1f0ee38879e.jpg"
            ],
            "additional_information": [
                "170~180",
                "95"
            ],
            "use_share": "T",
            "product_no": 10,
            "tags": [
                "cool",
                "best"
            ]
        }
    }'
    

    Response example:

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

    Specification

    Property Description
    SCOPE WRITE_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    content

    Max Length : [2000]

    리뷰 내용

    rating

    평점

    Rating of review.

    additional_information

    추가항목

    images

    첨부 이미지

    Image that attached at review.

    use_share

    SNS 공유 여부

    Whether share review to SNS.

    T : 공유함
    F : 공유안함

    Delete a review

    Definition

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

    Request example:

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

    Response example:

    {
        "review": {
            "review_no": 1
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    Reviews comments

    Comments indicate the response of other customers or the shopping mall manager to the review. Comments are embed entity that belong to reviews.

    Reviews comments properties

    Attribute Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    review_no

    리뷰 번호

    comment_no

    댓글 번호

    content

    댓글 내용

    writer

    작성자명

    nickname

    작성자 별명

    ip

    IP

    작성자의 IP 주소

    IP address of review writer.

    writing_id

    작성자 회원 아이디

    created_date

    Date
    timezone

    작성 일자

    Create a reviews comment

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "writing_id": "user1",
            "content": "sample comment."
        }
    }'
    

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    writing_id

    작성자 회원 아이디

    Member ID of review writer.

    content
    Required

    댓글 내용

    Content of review.

    List all reviews comments

    Definition

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

    Request example:

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

    Response example:

    {
        "comments": [
            {
                "shop_no": 1,
                "review_no": 1,
                "comment_no": 12,
                "content": "sample comment.",
                "writer": "John Doe",
                "nickname": "Cool john dude",
                "ip": "127.0.0.1",
                "writing_id": "user1",
                "created_date": "2018-01-22T15:52:51+09:00"
            },
            {
                "shop_no": 1,
                "review_no": 1,
                "comment_no": 11,
                "content": "sample comment.",
                "writer": "John Doe",
                "nickname": "Cool john dude",
                "ip": "127.0.0.1",
                "writing_id": "user1",
                "created_date": "2018-01-22T15:51:39+09:00"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    limit

    Min : [1]

    목록에 표시 할 목록 갯수

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

    DEFAULT 50

    offset

    Min : [0]

    목록을 가져올 시작 위치

    Set the start location of search result.

    Get a reviews comment

    Definition

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

    Request example:

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

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    Update a reviews comment

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/reviews/1/comments/11' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "content": "modify sample comment."
        }
    }'
    

    Response example:

    {
        "comment": {
            "shop_no": 1,
            "review_no": 1,
            "comment_no": 11,
            "content": "modify sample comment.",
            "writer": "John Doe",
            "nickname": "Cool john dude",
            "ip": "127.0.0.1",
            "writing_id": "user1",
            "created_date": "2018-01-22T15:51:39+09:00"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    content
    Required

    댓글 내용

    Content of review.

    Delete a reviews comment

    Definition

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

    Request example:

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

    Response example:

    {
        "comment": {
            "review_no": 1,
            "comment_no": 11
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_COMMUNITY
    Request Limit 100

    Request

    Parameter Description
    shop_no

    멀티쇼핑몰 번호

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    review_no
    Required

    리뷰 번호

    comment_no
    Required

    댓글 번호

    Scripttags

    The script API allows you to install remotely located scripts on a specific page of the mall. The script API makes it easy to add function to the mall without changing the design of the mall.

    Scripttags properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    script_no

    Unique number of script

    Unique number of script

    client_id

    Client ID

    Client ID that installed script.

    src

    URL

    Original script path

    Original path of script which to be installed

    display_location

    Screen path

    "Path of screen display" to display Script. "Path of screen display" represents specific role of each page.

    (Example : "Path of screen display" of /product/detail.html page is PRODUCT DETAIL)

    "Path of screen display" automatically assigned followed by module used for the page but also can be modified.

    If "all", the script will be applied to the entire page.

    Display Location Code

    skin_no

    Skin number

    Skin number that wants to be applied scripttags.

    created_date

    timezone

    Created date

    Date of installed script

    updated_date

    timezone

    Updated date

    Date of modified script

    List all scripttags

    Definition

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

    Request example:

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

    Response example:

    {
        "scripttags": [
            {
                "shop_no": 1,
                "script_no": "1509432821494844",
                "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
                "src": "https:\/\/js-aplenty.com\/bar.js",
                "display_location": [
                    "BOARD_FREE_LIST"
                ],
                "skin_no": [
                    1,
                    2
                ],
                "created_date": "2017-10-31T15:53:41+09:00",
                "updated_date": "2017-11-03T18:05:32+09:00"
            },
            {
                "shop_no": 1,
                "script_no": "1509699932016345",
                "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
                "src": "https:\/\/js-aplenty.com\/bar.js",
                "display_location": [
                    "PRODUCT_LIST",
                    "PRODUCT_DETAIL"
                ],
                "skin_no": null,
                "created_date": "2017-11-03T18:05:32+09:00",
                "updated_date": "2017-11-03T18:05:32+09:00"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    script_no

    Unique number of script

    Search the unique number of the script.

    src

    URL

    Original script path

    Search for the path of original script.

    display_location

    Screen path

    "Path of screen display" to display Script. "Path of screen display" represents specific role of each page.

    (Example : "Path of screen display" of /product/detail.html page is PRODUCT DETAIL)

    "Path of screen display" automatically assigned followed by module used for the page but also can be modified.

    If "all", the script will be applied to the entire page.

    Display Location Code

    You can search multiple item with ,(comma)

    skin_no

    Skin number

    Skin number that wants to be applied scripttags.

    You can search multiple item with ,(comma)

    created_start_date

    Date
    timezone

    Script installation date search start date

    Search for script that installed date is after a certain date.
    Must use with 'created end date' simultaneously.

    created_end_date

    Date
    timezone

    Script installation date search end date

    Search for script that installed date is before a certain date.
    Must use with 'created start date' simultaneously.

    updated_start_date

    Date
    timezone

    Script modification date search start date

    Search for script that modified date is after a certain date.

    Must use with 'updated end date' simultaneously.

    updated_end_date

    Date
    timezone

    Script modification date search end date

    Search for script that modified date is before a certain date.

    Must use with 'updated start date' simultaneously.

    Count all scripttags

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 2
    }
    

    Specification

    Property Description
    SCOPE READ_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    script_no

    Unique number of script

    Search the unique number of the script.

    src

    URL

    Original script path

    Search for the path of original script.

    display_location

    Screen path

    Search for the path which installed the script.

    skin_no

    Skin number

    Skin number that wants to be applied scripttags.

    You can search multiple item with ,(comma)

    created_start_date

    Date
    timezone

    Script installation date search start date

    Search for script that installed date is after a certain date.

    Must use with 'created end date' simultaneously.

    created_end_date

    Date
    timezone

    Script installation date search end date

    Search for script that installed date is before a certain date.

    Must use with 'created end date' simultaneously.

    updated_start_date

    Date
    timezone

    Script modification date search start date

    Search for script that modified date is after a certain date.

    Must use with 'updated end date' simultaneously.

    updated_end_date

    Date
    timezone

    Script modification date search end date

    Search for script that modified date is before a certain date.

    Must use with 'updated start date' simultaneously.

    Get a scripttag

    Definition

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

    Request example:

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

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1509699932016345",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-11-03T18:05:32+09:00",
            "updated_date": "2017-11-03T18:05:32+09:00"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    script_no

    Unique number of script

    Search the unique number of the script.

    Create a scripttag

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ]
        }
    }'
    

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1527128695613925",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\\\/\\\/js-aplenty.com\\\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-03-15T13:27:53+09:00",
            "updated_date": "2017-03-15T13:27:53+09:00"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    src
    Required

    URL

    Original script path

    Original path of script which to be installed

    display_location
    Required

    Screen path

    "Path of screen display" to display Script. "Path of screen display" represents specific role of each page.

    (Example : "Path of screen display" of /product/detail.html page is PRODUCT DETAIL)

    "Path of screen display" automatically assigned followed by module used for the page but also can be modified.

    If "all", the script will be applied to the entire page.

    Display Location Code

    skin_no

    Skin number

    Skin number that wants to be applied scripttags.

    Update a scripttag

    Definition

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

    Request example:

    curl -X PUT \
      'https://{mallid}.cafe24api.com/api/v2/admin/scripttags/1509699932016345' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "shop_no": 1,
        "request": {
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ]
        }
    }'
    

    Response example:

    {
        "scripttag": {
            "shop_no": 1,
            "script_no": "1509432821494844",
            "client_id": "AMj8UZhBC9zsyTlFGI6PzC",
            "src": "https:\/\/js-aplenty.com\/bar.js",
            "display_location": [
                "PRODUCT_LIST",
                "PRODUCT_DETAIL"
            ],
            "skin_no": [
                3,
                4
            ],
            "created_date": "2017-10-31T15:53:41+09:00",
            "updated_date": "2017-11-06T10:33:57+09:00"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    script_no
    Required

    Unique number of script

    Unique number of script

    src

    URL

    Original script path

    Original path of script which to be installed

    display_location

    Screen path

    "Path of screen display" to display Script. "Path of screen display" represents specific role of each page.

    (Example : "Path of screen display" of /product/detail.html page is PRODUCT DETAIL)

    "Path of screen display" automatically assigned followed by module used for the page but also can be modified.

    If "all", the script will be applied to the entire page.

    Display Location Code

    skin_no

    Skin number

    Skin number that wants to be applied scripttags.

    Delete a scripttag

    ※ If you want to delete by multiple shopping mall, you can add "?Shop_no=N" parameter after end point.

    Definition

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

    Request example:

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

    Response example:

    {
        "scripttag": {
            "script_no": "1509699932016345"
        }
    }
    

    Specification

    Property Description
    SCOPE WRITE_APPLICATION
    Request Limit 10

    Request

    Parameter Description
    script_no
    Required

    Unique number of script

    Unique number of script

    Shops

    Shops is information of multi shopping malls that are created when two or more shopping malls are operated. Multi-shopping malls can be created up to 5, and they can be created in different languages and currencies, which can be used to operate multilingual shopping malls.
    The {#id} of Multi Shops is "shop_no".

    Shops properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    default

    Whether it is the basic shop

    Whether shop is default shop or not.

    T: default shop
    F: not a default shop

    shop_name

    Max Length : [255]

    Shop name

    Name of shopping mall.

    language_code

    Language code

    Default language code of multi shopping mall.

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

    language_name

    Max Length : [20]

    Language name

    Default language name of multi shopping mall.

    currency_code

    Type : [A-Z]

    Shopping mall currency code

    Currency code of multi shopping mall.

    KRW: ₩ Won (Korea)
    USD: $ Dollar (United States)
    JPY: ¥ Yen (Japan)
    CNY: ¥ Yuan (China)
    TWD: $NT Dollar (Taiwan)
    EUR: € Euro (European countries)
    BRL: R$ Real (Brazil)

    currency_name

    Currency name

    Currency name of multi shopping mall.

    reference_currency_code

    Type : [A-Z]

    Reference currency code

    Reference currency code of multi shopping mall.

    KRW: ₩ Won (Korea)
    USD: $ Dollar (United States)
    JPY: ¥ Yen (Japan)
    CNY: ¥ Yuan (China)

    reference_currency_name

    Reference currency name

    Reference currency name of multi shopping mall.

    pc_skin_no

    Pc skin no

    Design number of PC shopping mall.

    mobile_skin_no

    Mobile skin no

    Design number of Mobile shopping mall.

    base_domain

    Max Length : [63]

    Base domain

    Base domain.

    primary_domain

    Max Length : [63]

    Primary domain

    Representative domain of multi shopping mall.

    slave_domain

    Slave domain

    Connected domain of shopping mall.

    active

    Active

    Whether activating multi shopping mall or not.

    T: activated
    F: deactivated

    List all shops

    Definition

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

    Request example:

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

    Response example:

    {
        "shops": [
            {
                "shop_no": 1,
                "default": "T",
                "shop_name": "My Shop",
                "language_code": "ko_KR",
                "language_name": "Korean",
                "currency_code": "KRW",
                "currency_name": "₩ Won (Korea)",
                "reference_currency_code": "",
                "reference_currency_name": null,
                "pc_skin_no": 1,
                "mobile_skin_no": 2,
                "base_domain": "sampleid.cafe24.com",
                "primary_domain": "samplemall.com",
                "slave_domain": [
                    "sampledomain1.com",
                    "ko.sampledomain1.com"
                ],
                "active": "T"
            },
            {
                "shop_no": 2,
                "default": "F",
                "shop_name": "My Shop USA",
                "language_code": "en_US",
                "language_name": "English",
                "currency_code": "USD",
                "currency_name": "$ Dollor (US)",
                "reference_currency_code": "",
                "reference_currency_name": null,
                "pc_skin_no": 3,
                "mobile_skin_no": 4,
                "base_domain": "shop2.sampleid.cafe24.com",
                "primary_domain": "shop2.samplemall.com",
                "slave_domain": [
                    "sampledomain2.com",
                    "en.sampledomain2.com"
                ],
                "active": "T"
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_STORE
    Request Limit 30

    Get a shop

    Definition

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

    Request example:

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

    Response example:

    {
        "shop": {
            "shop_no": 1,
            "default": "T",
            "shop_name": "My Shop",
            "language_code": "ko_KR",
            "language_name": "Korean",
            "currency_code": "KRW",
            "currency_name": "₩ Won (Korea)",
            "reference_currency_code": "",
            "reference_currency_name": null,
            "pc_skin_no": null,
            "mobile_skin_no": null,
            "base_domain": "sampleid.cafe24.com",
            "primary_domain": "samplemall.com",
            "slave_domain": [
                "sampledomain1.com",
                "ko.sampledomain1.com"
            ],
            "active": "T"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_STORE
    Request Limit 30

    Request

    Parameter Description
    shop_no
    Required

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    Store

    The store can get the basic information of the shopping mall such as shopping mall name, manager information, business registration number and customer center phone number of shopping mall.

    Store properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    shop_name

    Shop name

    mall_id

    Store ID

    Shopping mall ID. Also used in store manager's name and used in base domain.

    base_domain

    Base domain

    Auto generated and free default domain. You can access the shoopping mall with this domain.

    primary_domain

    Primary domain

    A representative domain connected to a shopping mall. It is dispalyed only when connecting representative domains.

    company_registration_no

    Company registration number

    The business registration number of the shopping mall issued in the country where the business is located.

    company_name

    Company name

    Business name or company name registered at the time of business registration.

    president_name

    CEO

    The name of the representative registered at the time of business registration.

    company_condition

    Business

    Business registered at business registration.

    company_line

    Business category

    Business category registered at business registration.

    country

    Country of business

    Name of the country where the business is located.

    zipcode

    Zipcode

    Postal code of your business

    address1

    Address 1

    Business address (city / county / province)

    address2

    Address 2

    Business address (street address)

    phone

    Office phone number

    fax

    Office fax number

    email

    Email

    The representative email of the mall. It is used as a sender's e-mail address when sending an automatic mail to a customer. It is also used as an e-mail address when an manager receives an automatic mail.

    mall_url

    Shopping mall address

    mail_order_sales_registration

    Report mail-order business

    T:Reported
    F:Not Reported

    mail_order_sales_registration_number

    Mail-order business report number

    missing_report_reason_type

    Reason of no mail-order business report

    If you did not report mail-order business, Its reason.

    missing_report_reason

    Detailed reason of no mail-order business report

    If the reason for not report mail-order business is "other", the reason for detail.

    about_us_contents

    About us

    A brief introduction to the mall. It is displayed on the company introduction page of the shopping mall.

    company_map_url

    Company map URL

    Show a brief map of the mall. It is displayed on the company introduction page of the shopping mall.

    customer_service_phone

    Customer center service/order phone

    Customer center call number displayed on the shopping mall page.

    customer_service_email

    Customer center service/order e-mail

    Customer center contact email address displayed on shopping mall page.

    customer_service_fax

    Customer center fax number

    Customer center fax number displayed on the shopping page.

    customer_service_sms

    Customer center SMS number

    Customer center SMS number displayed on the shopping page.

    customer_service_hours

    Customer center operation time

    The customer center open hours displayed on the shopping page.

    privacy_officer_name

    Privacy officer's name

    The name of the person in charge of personal information protection displayed on the shopping mall page.

    privacy_officer_position

    Privacy officer's position

    privacy_officer_department

    Privacy officer's department

    privacy_officer_phone

    Privacy officer's phone number

    The phone number of the person in charge of privacy protection displayed on the shopping mall page.

    privacy_officer_email

    Privacy officer's email address

    The e-mail address of the person in charge of privacy protection displayed on the shopping mall page.

    contact_us_mobile

    Whether to display the service inquiry guide in mobile phone

    Whether to expose service information to mobile website.

    T: Displayed
    F: Not displayed

    contact_us_contents

    Service contact information

    Details of service contact information exposed on the product detail page.

    Get a store

    Definition

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

    Request example:

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

    Response example:

    {
        "store": {
            "shop_no": 1,
            "shop_name": "My Shopping Mall",
            "mall_id": "myshop",
            "base_domain": "sample.cafe24.com",
            "primary_domain": "sample.com",
            "company_registration_no": "118-81-20586",
            "company_name": "My Shopping Mall",
            "president_name": "John Doe",
            "company_condition": "Retail",
            "company_line": "E-Commerce Product",
            "country": "Korea",
            "zipcode": "07071",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "phone": "02-0000-0000",
            "fax": "02-0000-0000",
            "email": "sample@sample.com",
            "mall_url": "http:\/\/sample.com",
            "mail_order_sales_registration": "T",
            "mail_order_sales_registration_number": "강남 제 02-680-014호",
            "missing_report_reason_type": "Preparing for Register",
            "missing_report_reason": "Preparing to report ecommerce business",
            "about_us_contents": "<b>My Shopping Mall Information<\/b>",
            "company_map_url": "\/\/myshop.cafe24.com\/web\/upload\/map.jpg",
            "customer_service_phone": "02-0000-0000",
            "customer_service_email": "sample@sample.com",
            "customer_service_fax": "02-0000-0000",
            "customer_service_sms": "02-0000-0000",
            "customer_service_hours": "9:00 AM ~ 5:00 PM",
            "privacy_officer_name": "Hong Gildong",
            "privacy_officer_position": "Manager",
            "privacy_officer_department": "Information Security Team",
            "privacy_officer_phone": "02-0000-0000",
            "privacy_officer_email": "sample@sample.com",
            "contact_us_mobile": "T",
            "contact_us_contents": "Service Information"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_STORE
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    Suppliers

    Suppliers refer to information entered into the supplier by the "production information" of the product. Supplier means a company or individual who can supply goods to the shopping mall and sell the goods. The supplier is one of the sales categories that distinguish the goods, and the goods must have one supplier (use "self-supply" when not specified)
    The supplier's {#id} is "supplier_code".

    Suppliers properties

    Attribute Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    supplier_code

    Supplier code

    Unique number of each supplier. This number cannot be duplicated in a mall.

    supplier_name

    Max Length : [100]

    Supplier name

    Name of supplier. Supplier name is the basic information for mall to distinguish each supplier.

    status

    Approval status

    Business status information with corresponding supplier.

    A: Business on going
    P: On hold
    N: Business terminated

    commission

    Commission

    Commission information for commission payment type(P).

    payment_period

    Payment frequency term

    You can set the payment frequency term.

    0 : 선택안함
    C : 일일정산
    B : 주간정산
    A : 월간정산

    business_item

    Max Length : [255]

    Product type for business

    Product type of business dealing with supplier.

    payment_type

    Payment type

    You may choose the type of payment to paying with supplier.
    commission type : Type of make a payment corresponding to a commission which set to product selling price.
    buying type : Type of make a payment corresponding to a supplier price which inputted at a product registration.

    P: Commission type
    D: Buying type

    supplier_type

    Business type of supplier

    Business type of supplier.

    Wholesale : Sales only to a retail shop not a regular customer.
    Retail : Purchase product and sales it to a regular customer.
    Store in mall : Store in mall.

    WS: Wholesale
    SF: Retail
    BS: Store in mall
    ET: Other

    use_supplier

    Use classification

    Whether use the supplier or not.

    T: Use
    F: Do not use

    created_date

    timezone

    등록일

    Created date of supplier information.

    updated_date

    timezone

    수정일

    Modified date of supplier information.

    trading_type

    Trade type

    Trade type which provides from the supplier.

    Retail : Seller purchase the product and deliver it to a customer.
    Direct shipping : Supplier ships ordered product to a customer.

    It can be displayed only in detail inquiry.

    D: Reatil
    C: Direct shipping

    payment_method

    정산시기

    Criteria status for payment.
    10 : Complete payment
    30 : Start shipping
    40 : Shipping complete

    It can be displayed only in detail inquiry.

    10 : 결제완료
    30 : 배송시작
    40 : 배송완료

    payment_start_day

    Min : [0]~Max : [6]

    정산시작 요일

    Process payment at designated date.
    In case for Payment frequency term is Weekly term(B)

    0 : Sunday. Process payment
    1 : Monday. Process payment
    2 : Tuesday. Process payment
    3 : Wednesday. Process payment
    4 : Thursday. Process payment
    5 : Friday. Process payment
    6 : Saturday. Process payment

    It can be displayed only in detail inquiry.

    0 : 일요일
    1 : 월요일
    2 : 화요일
    3 : 수요일
    4 : 목요일
    5 : 금요일
    6 : 토요일

    payment_end_day

    Min : [0]~Max : [6]

    정산종료 요일

    Process payment at designated date.
    In case for Payment frequency term is Weekly term(B)

    0 : Sunday. Process payment
    1 : Monday. Process payment
    2 : Tuesday. Process payment
    3 : Wednesday. Process payment
    4 : Thursday. Process payment
    5 : Friday. Process payment
    6 : Saturday. Process payment

    It can be displayed only in detail inquiry.

    0 : 일요일
    1 : 월요일
    2 : 화요일
    3 : 수요일
    4 : 목요일
    5 : 금요일
    6 : 토요일

    payment_start_date

    Min : [1]~Max : [31]

    정산시작 일

    Set the payment start date in case for Payment frequency term is Monthly term(A)

    It can be displayed only in detail inquiry.

    payment_end_date

    Min : [1]~Max : [31]

    정산종료 일

    Set the payment end date in case for Payment frequency term is Monthly term(A)

    It can be displayed only in detail inquiry.

    bank_code

    Max Length : [50]

    Bank code

    Bank code for close payment to supplier.

    It can be displayed only in detail inquiry.

    bank_account_no

    Bank account no

    Bank account number for close payment to supplier.

    It can be displayed only in detail inquiry.

    bank_account_name

    Bank account holder number

    Bank account name for close payment to supplier.

    It can be displayed only in detail inquiry.

    phone

    Max Length : [20]

    Office phone number

    Office phone number of supplier.

    It can be displayed only in detail inquiry.

    fax

    Max Length : [20]

    Office fax number

    Office fax number of supplier.

    It can be displayed only in detail inquiry.

    zipcode

    Max Length : [7]

    Zipcode

    Zipcode of supplier.

    It can be displayed only in detail inquiry.

    address1

    Max Length : [255]

    Address 1

    Address1 of supplier. (Street address, P.O. box, company name, c/o)

    It can be displayed only in detail inquiry.

    address2

    Max Length : [255]

    Address 2

    Address2 of supplier. (Apartment, suite, unit, building, floor, etc)

    It can be displayed only in detail inquiry.

    market_zipcode

    Max Length : [7]

    Market address zip code

    It can be displayed only in detail inquiry.

    market_address1

    Market address 1

    It can be displayed only in detail inquiry.

    market_address2

    Market address 2

    It can be displayed only in detail inquiry.

    exchange_zipcode

    Max Length : [7]

    Return address zip code

    It can be displayed only in detail inquiry.

    exchange_address1

    Max Length : [255]

    Return address 1

    It can be displayed only in detail inquiry.

    exchange_address2

    Max Length : [255]

    Return address 2

    It can be displayed only in detail inquiry.

    homepage_url

    Max Length : [100]

    Home page address

    It can be displayed only in detail inquiry.

    mall_url

    Max Length : [100]

    Shopping mall address

    It can be displayed only in detail inquiry.

    manager_information

    In Charge

    Person in charge at supplier.

    It can be displayed only in detail inquiry.

    account_start_date

    Max Length : [10]

    Transaction start date

    It can be displayed only in detail inquiry.

    account_stop_date

    Max Length : [10]

    Transaction stop date

    It can be displayed only in detail inquiry.

    show_supplier_info

    Max Length : [100]

    Display the supplier information

    It can be displayed only in detail inquiry.

    SP: Phone number
    SM: Business address
    MA: Market address
    EA: Address for product return
    MN: Name of the person in charge
    MI: Contact of the person in charge

    memo

    Max Length : [255]

    Important memo

    Memo for manage supplier.

    It can be displayed only in detail inquiry.

    company_registration_no

    Max Length : [12]

    Company registration number

    Business registration number with corresponding supplier. Displays when unique business registration number issued following to a country.

    It can be displayed only in detail inquiry.

    company_name

    Company name

    Company name that supplier registered when registration of enterprise.

    It can be displayed only in detail inquiry.

    president_name

    CEO

    President name that supplier registered when registration of enterprise.

    It can be displayed only in detail inquiry.

    company_condition

    Business

    Company type that supplier registered when registration of enterprise.

    It can be displayed only in detail inquiry.

    company_line

    Business category

    Company item that supplier registered when registration of enterprise.

    It can be displayed only in detail inquiry.

    company_introduction

    회사 소개

    A brief introduction of the supplier.

    It can be displayed only in detail inquiry.

    List all suppliers

    Definition

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

    Request example:

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

    Response example:

    {
        "suppliers": [
            {
                "shop_no": 1,
                "supplier_code": "S0000000",
                "supplier_name": "Supply Name",
                "status": "A",
                "commission": "0.00",
                "payment_period": "A",
                "business_item": "Online Shop",
                "payment_type": "D",
                "supplier_type": "WS",
                "use_supplier": "T",
                "created_date": "",
                "updated_date": "2018-09-04T13:42:04+09:00"
            },
            {
                "shop_no": 1,
                "supplier_code": "S000000A",
                "supplier_name": "Supply Name",
                "status": "A",
                "commission": "10.00",
                "payment_period": "0",
                "business_item": "Online Shop",
                "payment_type": "P",
                "supplier_type": "WS",
                "use_supplier": "T",
                "created_date": "2018-09-04T13:42:04+09:00",
                "updated_date": ""
            }
        ]
    }
    

    Specification

    Property Description
    SCOPE READ_SUPPLY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    supplier_code

    Supplier code

    Unique number of each supplier. This number cannot be duplicated in a mall.

    You can search multiple item with ,(comma)

    supplier_name

    Supplier name

    Name of supplier. Supplier name is the basic information for mall to distinguish each supplier.

    You can search multiple item with ,(comma)

    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 suppliers

    Definition

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

    Request example:

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

    Response example:

    {
        "count": 3
    }
    

    Specification

    Property Description
    SCOPE READ_SUPPLY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    supplier_code

    Supplier code

    Unique number of each supplier. This number cannot be duplicated in a mall.

    You can search multiple item with ,(comma)

    supplier_name

    Supplier name

    Name of supplier. Supplier name is the basic information for mall to distinguish each supplier.

    You can search multiple item with ,(comma)

    Get a supplier

    Definition

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

    Request example:

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

    Response example:

    {
        "supplier": {
            "shop_no": 1,
            "supplier_name": "Default Supplier",
            "supplier_code": "S0000000",
            "use_supplier": "T",
            "trading_type": "D",
            "supplier_type": "WS",
            "status": "A",
            "business_item": "Default Product Type",
            "payment_type": "D",
            "commission": "0.00",
            "payment_period": "A",
            "payment_method": 30,
            "payment_start_day": null,
            "payment_end_day": null,
            "payment_start_date": 9,
            "payment_end_date": 30,
            "bank_code": "bank_04",
            "bank_account_no": "000-0000-00000",
            "bank_account_name": "Acoount Name",
            "phone": "010-0000-0000",
            "fax": "02-0000-0000",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "address2": "Professional Construction Hall",
            "market_zipcode": "07071",
            "market_address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "market_address2": "Professional Construction Hall",
            "exchange_zipcode": "07071",
            "exchange_address1": "Sindaebang dong Dongjak-gu, Seoul, Republic of Korea",
            "exchange_address2": "Professional Construction Hall",
            "homepage_url": "sample.sample.com",
            "mall_url": "sample.sample.com",
            "manager_information": [
                {
                    "name": "John Doe",
                    "phone": "010-0000-0000",
                    "email": "sample@sample.com",
                    "use_sms": "T"
                },
                {
                    "name": "Jane Doe",
                    "phone": "010-0000-0000",
                    "email": "sample@sample.com",
                    "use_sms": "T"
                }
            ],
            "account_start_date": "2018-01-01",
            "account_stop_date": "2018-01-02",
            "show_supplier_info": "SP,SM",
            "memo": "Memo Description",
            "company_registration_no": "118-81-20586",
            "company_name": "Company Name",
            "president_name": "Representative name",
            "company_condition": "Industry",
            "company_line": "Online",
            "company_introduction": "company_introduction"
        }
    }
    

    Specification

    Property Description
    SCOPE READ_SUPPLY
    Request Limit 30

    Request

    Parameter Description
    shop_no

    Shop Number

    Multi shopping mall number used for shopping mall classification.

    DEFAULT 1

    supplier_code
    Required

    Supplier code

    Unique number of each supplier. This number cannot be duplicated in a mall.

    Create a supplier

    Definition

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

    Request example:

    curl -X POST \
      'https://{mallid}.cafe24api.com/api/v2/admin/suppliers' \
      -H 'Authorization: Bearer {access_token}' \
      -H 'Content-Type: application/json' \
      -d '{
        "request": {
            "shop_no": 1,
            "supplier_name": "Default Supplier",
            "use_supplier": "T",
            "trading_type": "D",
            "supplier_type": "WS",
            "status": "A",
            "business_item": "Default Product Type",
            "payment_type": "D",
            "commission": "0.00",
            "payment_period": "A",
            "payment_method": "30",
            "payment_start_date": 9,
            "payment_end_date": 30,
            "phone": "010-0000-0000",
            "fax": "02-0000-0000",
            "zipcode": "00000",
            "address1": "Sindaebang dong Dongjak-gu Seoul Republic of Korea",
            "address2": "Professional Construction Hall",
            "market_zipcode": "07071",
            "market_address1": "Sindaebang dong Dongjak-gu Seoul Republic of Korea",
            "market_address2": "Professional Construction Hall",
            "exchange_zipcode": "07071",
            "exchange_address1": "Sindaebang dong Dongjak-gu Seoul Republic of Korea",
            "exchange_address2": "Professional Construction Hall",
            "homepage_url": "sample.sample.com",
            "mall_url": "sample.sample.com",
            "account_start_date": "2018-01-01",
            "account_stop_date": "2018-01-02",
            "memo": "Memo Description",
            "company_registration_no": "118-81-20586",
            "company_name": "Company Name",
            "president_name": "Representative name",
            "company_condition": "Industry",
            "company_line": "Online",
            "company_introduction": "company_introduction"
        }
    }'
    

    Response example:

    {
        "supplier": {
            "shop_no": 1