닫기

  • Category

  • Product

  • Collection

  • Supply

  • Personal

  • Order

  • Community

  • Customer

  • Notification

  • Store

  • Promotion

  • Design

  • Application

  • Salesreport

  • Privacy

  • Mileage

  • Shipping

    • API Index

    non-print

    API Index

    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

    • API request and response support JSON format.

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

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

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

    Method

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

    • POST : Create the resource.

    • GET: Read data the resource.

    • PUT : Modify(Update) the resource.

    • DELETE : Delete (delete) the resource.

    Admin API Intro

    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 resource and available only after pass Oauth 2.0 authentication.

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

    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 Access Token is missing
    2) When Access Token is wrong
    3) When Access Token is expired
    4) Unrecognizable client    		 Check whether the Access Token is granted and used via valid process.
    401 client_id is missing when using Front API Check whether using valid client_id.
    403 1) Access Token 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

    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.

    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

    2. Search several conditions in parameter.

    Multiple values can be retrieved simultaneously using commas(,) if supported by the API. (Only less than 100 items are allowed.)

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

    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

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

    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

    4. Check details and key

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

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

    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

    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.

    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

    6. Field Parameters

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

    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

    7. Embed Parameters

    Embedded Resource belonging to the product when inquiring an item (e.g. variants,inventories) If you need to inquire the item and inventory together, you can inquire the data of the lower resource with using the ' embed ' parameter.

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

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

    API Limit

    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 twice per second and can be recalled as a decrease.

    • If the app calls the API twice a second, you can continue to use the API calls without restriction.

    • If more than "Request Limit" calls are generated momentarily within a second, return the 429 error (too many requests).

    • If more than 10 requests per second are made from the same IP address of an online store, the requests may be considered abnormal or malicious.

    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.

    X-Api-Call-Limit : 1/40

    Versioning

    Version 2021-03-01 (latest)

    You can check the version release date for changes not compatible with the previous version.

    You can specify a version of your choice in custom headers "X-Cafe24-Api-Version". If not specified, the latest version is used.

    Example (request)

    Authentication

    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.

    • {mallid} : Enter the appropriate shopping mall ID.

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

    • {state} : The value entered above is returned as a value to prevent modulation.

    • {redirect_anI} : Enter the Redirect URL for the app created by the developer center.

    • {script} : You can enter the privileges of the resource server to access the access token.

    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.

    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}

    Get Access Token

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

    • {mallid} : Enter the corresponding shopping mall ID.

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

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

    • {code} : Enter the issued code.

    • {redirect_anI} : Enter the Redirect URL for the app created by the developer center.

    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.

    Example (request)
    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"
}

    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.

    • {mallid} : Enter the corresponding shopping mall ID.

    • {domain} : Enter the domain of the shopping mall.

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

    • {client_secret} : Enter the client_secret of the app created by the developer center.

    • {refresh_token} : Enter the refresh_token received when the token was issued.

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

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

    Example (request)
    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"
}

    Category

    Autodisplay

    Endpoints 
    GET /api/v2/admin/autodisplay
POST /api/v2/admin/autodisplay
PUT /api/v2/admin/autodisplay/{display_no}
DELETE /api/v2/admin/autodisplay/{display_no}

    Autodisplay properties

    Attribute Description
    shop_no

    Shop Number
    display_no

    auto layout number
    use_main

    Displayed on home page

    T: yes
    F: no
    category_no

    Category number
    display_group

    detailed product category
    display_count

    Min : [1]~Max : [200]

    maximum quantity per auto layout
    use_reservation

    schedule layout

    T: yes
    F: no
    start_date

    timezone

    start date
    use_hashtag

    use hashtag

    T: yes
    F: no
    hash_tags

    hashtag
    display_sort

    sorting order

    AOD: no. orders (high-low)
    AOA: no. orders (low-high)
    AVD: views (high-low)
    AVA: views (high-low)
    ARD: conversion rate (high-low)
    ARA: conversion rate (low-high)
    ACD: click value (high-low)
    AND: date added (latest first)
    APD: price (high-low)
    APA: price (low-high)
    RD : Date added (latest first)
    RA : Date added (oldest first)
    UD : Date edited (latest first)
    UA : Date edited (oldest first)
    NA : Product name (A-Z)
    ND : Product name (Z-A)
    PD : Price (high-low)
    PA :Price (low-high)
    SD : Sales (high-low)
    SA : Sales (low-high)
    CD : Views (high-low)
    CA : Views (low-high)
    LD : Likes (high-low)
    LA : Likes (low-high)
    timetable

    Array Max : [24]

    update frequency
    period

    date range for data collection

    1: 1 day
    3: 3 days
    7: 1 week (7 days)
    30: 30 days
    except_categories

    Exceptions category

    List all autodisplay

    GET

    Specification

    Property Description
    SCOPE mall.read_category
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    display_no

    auto layout number

    Definition Copy
    Request example: Copy
    Response example:

    Create an autodisplay

    POST

    Specification

    Property Description
    SCOPE mall.write_category
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    use_main
    Required

    Displayed on home page

    T: yes
    F: no

    category_no
    Required

    Category number

    display_group
    Required

    detailed product category

    display_count
    Required

    Min : [1]~Max : [200]

    maximum quantity per auto layout

    use_reservation
    Required

    schedule layout

    T: yes
    F: no

    start_date

    timezone

    start date

    use_hashtag
    Required

    use hashtag

    T: yes
    F: no

    hash_tags

    hashtag

    display_sort

    sorting order

    AOD: no. orders (high-low)
    AOA: no. orders (low-high)
    AVD: views (high-low)
    AVA: views (high-low)
    ARD: conversion rate (high-low)
    ARA: conversion rate (low-high)
    ACD: click value (high-low)
    AND: date added (latest first)
    APD: price (high-low)
    APA: price (low-high)
    RD : Date added (latest first)
    RA : Date added (oldest first)
    UD : Date edited (latest first)
    UA : Date edited (oldest first)
    NA : Product name (A-Z)
    ND : Product name (Z-A)
    PD : Price (high-low)
    PA :Price (low-high)
    SD : Sales (high-low)
    SA : Sales (low-high)
    CD : Views (high-low)
    CA : Views (low-high)
    LD : Likes (high-low)
    LA : Likes (low-high)

    timetable

    Array Max : [24]

    update frequency

    period

    date range for data collection

    1: 1 day
    3: 3 days
    7: 1 week (7 days)
    30: 30 days

    except_categories

    Exceptions category

    Definition Copy
    Request example: Copy
    Response example:

    Update an autodisplay

    PUT

    Specification

    Property Description
    SCOPE mall.write_category
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    display_no
    Required

    auto layout number

    display_count

    Min : [1]~Max : [200]

    maximum quantity per auto layout

    use_reservation

    schedule layout

    T: yes
    F: no

    start_date

    timezone

    start date

    use_hashtag

    use hashtag

    T: yes
    F: no

    hash_tags

    hashtag

    display_sort

    sorting order

    AOD: no. orders (high-low)
    AOA: no. orders (low-high)
    AVD: views (high-low)
    AVA: views (high-low)
    ARD: conversion rate (high-low)
    ARA: conversion rate (low-high)
    ACD: click value (high-low)
    AND: date added (latest first)
    APD: price (high-low)
    APA: price (low-high)
    RD : Date added (latest first)
    RA : Date added (oldest first)
    UD : Date edited (latest first)
    UA : Date edited (oldest first)
    NA : Product name (A-Z)
    ND : Product name (Z-A)
    PD : Price (high-low)
    PA :Price (low-high)
    SD : Sales (high-low)
    SA : Sales (low-high)
    CD : Views (high-low)
    CA : Views (low-high)
    LD : Likes (high-low)
    LA : Likes (low-high)

    timetable

    Array Max : [24]

    update frequency

    period

    date range for data collection

    1: 1 day
    3: 3 days
    7: 1 week (7 days)
    30: 30 days

    except_categories

    Exceptions category

    Definition Copy
    Request example: Copy
    Response example:

    Delete an autodisplay

    DELETE

    Specification

    Property Description
    SCOPE mall.write_category
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    display_no
    Required

    auto layout number

    Definition Copy
    Request example: Copy
    Response example:

    Categories

    Categories Resource

    Categories allow the admin to display or categorize products in a way that customers can easily find them. You must display products in at least one category to sell them. One product can be displayed in multiple categories.

    Endpoints 
    GET /api/v2/admin/categories
GET /api/v2/admin/categories/count
GET /api/v2/admin/categories/{category_no}
POST /api/v2/admin/categories
PUT /api/v2/admin/categories/{category_no}
DELETE /api/v2/admin/categories/{category_no}

    Categories properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    category_no

    Category number

    A unique identifier assigned to a product category. It cannot be used for more than one product category.
    category_depth

    Min : [1]~Max : [4]

    Category depth

    Depth of the product category. There are four product category depths.
    parent_category_no

    Parent Category Number

    The category number of the parent category when the category is either 2 depth (subcategory 1), 3 depth (subcategory 2), or 4 depth (subcategory 3) category.
    For example, “parent_category_no=1” indicates the parent category is main category.
    category_name

    Max Length : [50]

    Category name

    Name of the product category
    display_type

    Display setting

    Whether the product category is displayed either on the PC store, mobile store, or on both stores.

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

    Full Category Name

    The names of all parent categories to which the product category belongs.
    full_category_no

    Full Category Number

    This shows the category numbers of all parent categories that the current category belongs to.
    root_category_no

    Top category number

    The category number of the main category to which the category belongs
    use_main

    Main classification display status

    Whether or not the product category is displayed on the main page. If it is, [True], the product category is displayed as a home category even if it is subcategory 1, 2, or 3.

    T: Displayed
    F: Not displayed
    use_display

    Display status

    Whether or not the product category is displayed. If it is “FALSE,” customers cannot access the product category. All multi-language stores must have the same settings.

    T: Displayed
    F: Not displayed
    display_order

    Display order

    The order in which the admin has placed product categories
    soldout_product_display

    Sold-out product display status

    It shows whether out-of-stock products are displayed at the top or at the bottom. You can check whether a product is sold-out via “sold-out” parameter in “List all products.”

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

    Sub-category Product display status

    Whether to display products in both the current category and its sub-categories.

    T: Display
    F: Do not display
    hashtag_product_display

    Hashtag based product display

    Whether or not to use “Hashtag-based product display”.

    *The feature is only available when you use [Shopping Curation].

    T: Display
    F: Do not display
    hash_tags

    Hashtag

    The list of hashtags in the current category.

    *The feature is only available when you use [Shopping Curation].
    product_display_scope

    Category display scope

    This determines whether the common product layout settings are applied to all product categories or different settings by section. If it is set as [Apply common settings to all products], you can change the sort settings with the following parameters:

    product_display_type
    product_display_key
    product_display_sort
    product_display_period

    If it is set as [Apply different settings by section], you can set the sort settings with the following 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

    The sorting method for the current category when [Product layout settings] is set as “Apply common settings to all categories.”

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

    Category display key

    The sorting criteria for the current category when [Product layout settings] is set as “Apply common settings to all categories” and the sorting method as “Automatic sorting” or “Automatic + Custom.”

    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

    Settings for sorting products in ascending or descending order

    D: Descending order
    A: Ascending order
    product_display_period

    Category display period

    The period during which sales or views are counted when sorting products by “Sales(S)” or “Views(C)” in descending order

    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

    The sorting method for [Products] when [Product layout settings] is set as “Apply different settings by section.”

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

    Category display key

    The sorting criteria for [Products] when [Product layout settings] is set as “Apply different settings by section”

    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

    Settings for sorting products in [Products] in ascending or descending order

    D: Descending order
    A: Ascending order
    normal_product_display_period

    Category display period

    The period during which sales or views are counted when sorting products in [Products] by “Sales(S)” or “Views(C)” in descending order

    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

    The sorting method for [Recommended products] when [Product layout settings] is set as “Apply different settings by section.”

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

    Category display key

    The sorting criteria for [Recommended products] when [Product layout settings] is set as “Apply different settings by section”

    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

    Settings for sorting products in [Recommended products] in ascending or descending order

    D: Descending order
    A: Ascending order
    recommend_product_display_period

    Category display period

    The period during which sales or views are counted when sorting products in [Recommended roducts] by “Sales(S)” or “Views(C)” in descending order

    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

    The sorting method for [New products] when [Product layout settings] is set as “Apply different settings by section.”

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

    Category display key

    The sorting criteria for [New products] when [Product layout settings] is set as “Apply different settings by section”

    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

    Settings for sorting products in [New products] in ascending or descending order

    D: Descending order
    A: Ascending order
    new_product_display_period

    Category display period

    The period during which sales or views are counted when sorting products in [New roducts] by “Sales(S)” or “Views(C)” in descending order

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

    permission to access

    F : for everyone
    T : members only
    G : for specific member group only
    A : for specific operator

    List all categories

    GET

    Specification

    Property Description
    SCOPE mall.read_category
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    Category depth

    Search for the depth of the category you want to retrieve

    category_no

    Category number

    Category number of the category you want to read

    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 categories of which names include the search query that you enter. The search query is case-insensitive.

    limit

    Min : [1]~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.

    Definition Copy
    Request example: Copy
    Response example:

    Count all categories

    GET

    Specification

    Property Description
    SCOPE mall.read_category
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    category_depth

    Min : [1]~Max : [4]

    Category depth

    Search for the category that you want to retrieve with its category depth.

    category_no

    Category number

    Category number of the category you want to read

    parent_category_no

    Parent Category Number

    You can search for the category with its parent category number.
    If you want to search for main categories, enter “parent_category_number=1.”

    category_name

    Category name

    Search for product categories of which names include the search query that you enter. The search query is case-insensitive.

    Definition Copy
    Request example: Copy
    Response example:

    Get a category

    GET

    Specification

    Property Description
    SCOPE mall.read_category
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    category_no
    Required

    Category number

    Category number of the category you want to read

    Definition Copy
    Request example: Copy
    Response example:

    Create a category

    POST

    Specification

    Property Description
    SCOPE mall.write_category
    Request Limit 40
    objects per single API call Limit 1

    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

    Whether the product category is displayed on either the PC store, mobile store, or on both stores.

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

    use_main

    Main classification display status

    Whether or not the product category is displayed on the main page. If it is, [True], the product category is displayed as a home category even if it is subcategory 1, 2, or 3.

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

    Definition Copy
    Request example: Copy
    Response example:

    Update a category

    PUT

    Specification

    Property Description
    SCOPE mall.write_category
    Request Limit 40
    objects per single API call Limit 1

    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

    Whether the product category is displayed either on the PC store, mobile store, or on both stores.

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

    use_main

    Main classification display status

    Whether or not the product category is displayed on the main page. If it is, [True], the product category is displayed as a home category even if it is subcategory 1, 2, or 3.

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

    Definition Copy
    Request example: Copy
    Response example:

    Delete a category

    DELETE

    Specification

    Property Description
    SCOPE mall.write_category
    Request Limit 40

    Request

    Parameter Description
    category_no
    Required

    Category number

    Definition Copy
    Request example: Copy
    Response example:

    Categories decorationimages

    Endpoints 
    GET /api/v2/admin/categories/{category_no}/decorationimages
PUT /api/v2/admin/categories/{category_no}/decorationimages

    Categories decorationimages properties

    Attribute Description
    shop_no

    Shop Number
    category_no

    Category number
    use_menu_image_pc

    menu image settings for PC store

    T: Used
    F: Not used
    menu_image_pc

    default menu image for PC store
    menu_over_image_pc

    overlay menu image for PC store
    use_top_image_pc

    header image settings for PC store

    T: Used
    F: Not used
    top_images_pc

    header image for PC store
    use_title_image_pc

    headline image settings for PC store

    T: Used
    F: Not used
    title_image_pc

    headline image for PC store
    use_menu_image_mobile

    menu image settings for mobile store

    T: Used
    F: Not used
    menu_image_mobile

    default menu image for mobile store
    use_top_image_mobile

    header image settings for mobile store

    T: Used
    F: Not used
    top_images_mobile

    Array Max : [3]

    header image for mobile store
    use_title_image_mobile

    headline image settings for mobile store

    T: Used
    F: Not used
    title_image_mobile

    headline image for mobile store

    List all categories decoration images

    GET

    Specification

    Property Description
    SCOPE mall.read_category
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    category_no
    Required

    Category number

    Definition Copy
    Request example: Copy
    Response example:

    Update a categories decorationimage

    PUT

    Specification

    Property Description
    SCOPE mall.write_category
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    category_no
    Required

    Category number

    use_menu_image_pc

    menu image settings for PC store

    T: Used
    F: Not used

    menu_image_pc

    default menu image for PC store

    menu_over_image_pc

    overlay menu image for PC store

    use_top_image_pc

    header image settings for PC store

    T: Used
    F: Not used

    top_images_pc

    Array Max : [3]

    header image for PC store

    use_title_image_pc

    headline image settings for PC store

    T: Used
    F: Not used

    title_image_pc

    headline image for PC store

    use_menu_image_mobile

    menu image settings for mobile store

    T: Used
    F: Not used

    menu_image_mobile

    default menu image for mobile store

    use_top_image_mobile

    header image settings for mobile store

    T: Used
    F: Not used

    top_images_mobile

    Array Max : [3]

    header image for mobile store

    use_title_image_mobile

    headline image settings for mobile store

    T: Used
    F: Not used

    title_image_mobile

    headline image for mobile store

    Definition Copy
    Request example: Copy
    Response example:

    Categories seo

    Endpoints 
    GET /api/v2/admin/categories/{category_no}/seo
PUT /api/v2/admin/categories/{category_no}/seo

    Categories seo properties

    Attribute Description
    shop_no

    Shop Number
    category_no

    Category number
    search_engine_exposure

    exposure setting for search engine

    T: Use
    F: Do not use
    meta_title

    Browser title
    meta_author

    Meta tag 1: Author
    meta_description

    Meta tag 2: Description
    meta_keywords

    Meta tag 3: Keywords

    List all categories seo

    GET

    Specification

    Property Description
    SCOPE mall.read_category
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    category_no
    Required

    Category number

    Definition Copy
    Request example: Copy
    Response example:

    Update a categories seo

    PUT

    Specification

    Property Description
    SCOPE mall.write_category
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    category_no
    Required

    Category number

    search_engine_exposure

    exposure setting for search engine

    T: Use
    F: Do not use

    meta_title

    Browser title

    meta_author

    Meta tag 1: Author

    meta_description

    Meta tag 2: Description

    meta_keywords

    Meta tag 3: Keywords

    Definition Copy
    Request example: Copy
    Response example:

    Mains

    Mains Resource

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

    Endpoints 
    GET /api/v2/admin/mains

    Mains properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    module_code

    Module code

    The module code assigned main display group
    display_group

    main category number
    group_name

    Group Name

    Category name defined when main categories were created
    soldout_sort_type

    Sold-out product display status

    The display location of sold out products.

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

    List all mains

    GET

    Specification

    Property Description
    SCOPE mall.read_category
    Request Limit 40
    Definition Copy
    Request example: Copy
    Response example:

    Product

    Bundleproducts

    Endpoints 
    GET /api/v2/admin/bundleproducts
GET /api/v2/admin/bundleproducts/{product_no}
POST /api/v2/admin/bundleproducts
PUT /api/v2/admin/bundleproducts/{product_no}
DELETE /api/v2/admin/bundleproducts/{product_no}

    Bundleproducts properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    product_no

    Product number

    A unique serial number assigned to a product. This number cannot be duplicated.
    product_code

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

    Product code

    A code assigned to a product by the system. This code cannot be duplicated.
    bundle_product_components

    composite product information
    custom_product_code

    Max Length : [40]

    Custom product code

    A code assigned to a product by the store admin. The code can be used by store admins who need their own separate code to manage products for inventory management or other reasons.
    product_name

    Max Length : [250]

    Product name

    Name of the product. This is the basic information to identify products and can be a query for searching for products. It can be entered in the HTML form.
    eng_product_name

    Max Length : [250]

    English name of product

    Product name in English. It can be used for international shipping.
    supply_product_name

    Max Length : [250]

    Supplier product name

    Product name entered by a supplier. The supplier can enter any name it needs to identify products. This name does not affect Product name.
    internal_product_name

    Max Length : [50]

    internal product name
    model_name

    Max Length : [100]

    Model name

    Model of the product
    display

    Whether display

    Whether the product is displayed on the store.
    If it is, it is diaplayed on the selected categories and on the home page.
    If it is not, it is not displayed on the store and customers cannot have access to and buy the product.

    T: Display
    F: Do not display
    selling

    whether selling

    Whether the product is for sale.
    If the product is archived while being displayed on the store, the product is marked as [out-of-stock] and customers cannot buy it.
    If the product is for sale while not on display, customers still cannot buy it as they do not have access to it.

    T: Sell
    F: Do not sell
    product_condition

    Product condition

    Condition of the 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 the product. It is displayed on the product layout page. Can be entered in HTML format. You can choose to show or hide the product summary in [Products>Product data display>Settings].
    product_tag

    Max Length : [200]

    Product tag

    Search terms for searching or categorizing products (hashtags)
    price_content

    Max Length : [20]

    Alternative phrase of the selling price

    Text that replaces price. Can be used when a product is temporarily out-of-stock or unavailable.
    buy_limit_by_product

    whether purchase restriction individual setting

    T: use
    F: do not use
    buy_limit_type

    Purchase limitation

    Whether or not to restrict purchase from guest accounts

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

    customer levels allowed to purchase the relevant product
    repurchase_restriction

    repurchase restriction

    T : restrict repurchase
    F : do not restrict repurchase
    single_purchase_restriction

    single purchase restriction

    T : restrict single purchase
    F : do not restrict on single purchase
    points_by_product

    whether use mileage individual setting

    F : use default setting
    T : individual setting
    points_setting_by_payment

    mileage individual setting - lower level item > basic setting mileage or mileage setting according to payment method

    B : Use the default reserve setting
    C : Earn based on the payment method
    points_amount

    Mileage setting
    except_member_points

    Mileage exception

    T : exclude setting an additional mileage accumulation for member group
    F : do not setting an additional mileage accumulation for member group
    adult_certification

    Adult certification

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

    T: Used
    F: Not used
    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.
    use_naverpay

    whether use Naver Pay

    T: Used
    F: Not used
    naverpay_type

    Naver Pay sales type

    C : Naver Pay + Shopping Mall Products at the same time
    O : Naver Pay only products
    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.
    sold_out

    Whether sold out or stock is available

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

    Product discount sale price Resource


    Can search with using embed parameter.
    decorationimages

    Decoration Image Resource


    Can search with using embed parameter.
    benefits

    Benefits Resource


    Can search with using embed parameter.
    additionalimages

    Array Max : [20]

    additional image resource


    Can search with using embed parameter.
    exposure_limit_type

    types of customers allowed to view the relevant product

    A: display to all
    M: display to customers only
    exposure_group_list

    customer levels allowed to view the relevant product
    bundle_product_sales

    bundle discount information
    category

    Category number

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

    planned exhibition number
    description

    Detail description of product

    Detail description of product. You may input description with HTML.
    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.
    separated_mobile_description

    add mobile version

    T: add mobile version product details
    F: apply PC version product details
    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.
    payment_info

    Payment info

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

    Shipping info

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

    Exchange info

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

    Service info

    Guidance for service warranty information. You may input this with HTML.
    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.
    simple_description

    Simple Product Description

    Simple description of product. Can Exposed at product display screen. You may input description with HTML.
    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.

    T: Used
    F: Not used
    shipping_method

    Shipping method

    Following is the method when 'individual_delivery' is TRUE

    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

    C: Pay after delivery
    P: Prepaid
    B: Select Prepaid/Pay after delivery
    shipping_period

    Shipping period

    (When using 'Shipping charge individually') Average transit time for make a delivery.
    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_area

    Max Length : [255]

    Shipping area

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

    Shipping charge

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

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

    Korean product category for overseas customs clearance

    Product name as Korean
    clearance_category_code

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

    Clearance category code
    additional_information

    Additional information list

    You may add additional information other than basic information.
    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

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

    whether display at main

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

    Array Max : [200]

    Related product

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

    Memos Resource


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.
    hits

    Product hits Resource


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.
    seo

    Product Seo Resource


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.
    tags

    Product Tag Resource


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.

    List all bundleproducts

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    discountprice
    embed

    Product discount sale price Resource


    Can search with using embed parameter.

    decorationimages
    embed

    Decoration Image Resource


    Can search with using embed parameter.

    benefits
    embed

    Benefits Resource


    Can search with using embed parameter.

    additionalimages
    embed

    additional image resource


    Can search with using embed parameter.

    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no

    Product number

    Number of a product.

    You can search multiple item with ,(comma)

    display

    Whether display

    T: Display
    F: Do not display

    selling

    whether selling

    T: Sell
    F: Do not sell

    product_code

    Product code

    You can search multiple item with ,(comma)

    product_tag

    Product tag

    You can search multiple item with ,(comma)

    custom_product_code

    Custom product code

    You can search multiple item with ,(comma)

    product_name

    Product name

    You can search multiple item with ,(comma)

    eng_product_name

    English name of product

    You can search multiple item with ,(comma)

    supply_product_name

    Supplier product name

    You can search multiple item with ,(comma)

    internal_product_name

    internal product name

    You can search multiple item with ,(comma)

    model_name

    Model name

    You can search multiple item with ,(comma)

    price_min

    Minimum price

    price_max

    Maximum price

    created_start_date

    timezone

    Registered date start

    created_end_date

    timezone

    Registered date end

    updated_start_date

    timezone

    Updated date start

    updated_end_date

    timezone

    Updated date end

    category

    Category number

    category_unapplied

    Unapplied Category

    T : Search for products that category unapplied

    include_sub_category

    include sub category

    T: Included

    product_weight

    Weight of product

    additional_information_key

    additional information key

    additional_information_value

    additional information value

    sort

    Sort order

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

    order

    Order by

    asc: Ascending
    desc: Descending

    limit

    Min : [1]~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.

    Definition Copy
    Request example: Copy
    Response example:

    Get a bundleproduct

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    Number of a product.

    discountprice
    embed

    Product discount sale price Resource


    Can search with using embed parameter.

    decorationimages
    embed

    Decoration Image Resource


    Can search with using embed parameter.

    benefits
    embed

    Benefits Resource


    Can search with using embed parameter.

    memos
    embed

    Memos Resource


    Can search with using embed parameter.

    hits
    embed

    Product hits Resource


    Can search with using embed parameter.

    seo
    embed

    Product Seo Resource


    Can search with using embed parameter.

    tags
    embed

    Product Tag Resource


    Can search with using embed parameter.

    additionalimages
    embed

    additional image resource


    Can search with using embed parameter.

    Definition Copy
    Request example: Copy
    Response example:

    Create a bundleproduct

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_name
    Required

    Max Length : [250]

    Product name

    Name of product.

    bundle_product_components
    Required

    composite product information

    product_no
    composite product number
    Required

    purchase_quantity
    number of purchased bundles
    Required
    bundle_product_sales
    Required

    bundle discount information

    discount_value
    bundle discount price
    Required

    discount_type
    bundle discount type
    Required

    P: percentage-based
    V: fixed price-based

    discount_round_unit
    bundle discount round-off unit

    F: no round-off
    -2: to the nearest hundredth
    -1: to the nearest tenth
    0: to the nearest one
    1: to the nearest ten
    2: to the nearest hundred
    3: to the nearest thousand

    discount_round_type
    bundle discount round-off method

    F: round down
    R: round off
    C: round up
    display

    Whether display

    Whether display or not.

    T: Display
    F: Do not display

    DEFAULT F

    selling

    whether selling

    Whether selling or not.

    T: Sell
    F: Do not sell

    DEFAULT F

    add_category_no

    Category no

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

    category_no
    category number
    Required

    recommend
    whether a product is added to a recommended product category
    DEFAULT F
    T: added
    F: not added

    new
    whether a product is added to a new product category
    DEFAULT F
    T: added
    F: not added
    custom_product_code

    Max Length : [40]

    Custom product code

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

    eng_product_name

    Max Length : [250]

    English name of product

    Name of product in english.

    supply_product_name

    Max Length : [250]

    Supplier product name

    internal_product_name

    Max Length : [50]

    internal product name

    model_name

    Max Length : [100]

    Model name

    Model name of product.

    use_naverpay

    whether use Naver Pay

    This cannot be used on Cafe24 Vietnam, Philippines.

    T: Used
    F: Not used

    naverpay_type

    Naver Pay sales type

    This cannot be used on Cafe24 Vietnam, Philippines.

    C : Naver Pay + Shopping Mall Products at the same time
    O : Naver Pay only products

    product_weight

    Min : [0]~Max : [999999.99]

    Weight of product

    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

    simple_description

    Simple Product Description

    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.

    This cannot be used on Cafe24 Vietnam, Philippines.

    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.

    shipping_period

    Array Max : [2]

    Shipping period

    Transit time.

    minimum
    minimum date range
    DEFAULT 1

    maximum
    maximum date range
    DEFAULT 7
    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

    This cannot be used on Cafe24 Vietnam, Philippines.

    C: Pay after delivery
    P: Prepaid
    B: Select Prepaid/Pay after 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)
    clearance_category_code

    detail_image

    Detail image

    Detail image.

    list_image

    List image

    List image.

    tiny_image

    Tiny image

    small_image

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

    DEFAULT A

    additional_information

    Additional information list

    Additional item.

    key
    Additional field key
    Required

    value
    Additional field value
    price_content

    Max Length : [20]

    Alternative phrase of the selling price

    buy_limit_by_product

    whether purchase restriction individual setting

    T: use
    F: do not use

    DEFAULT F

    buy_limit_type

    Purchase limitation

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

    DEFAULT F

    buy_group_list

    customer levels allowed to purchase the relevant product

    repurchase_restriction

    repurchase restriction

    T : restrict repurchase
    F : do not restrict repurchase

    DEFAULT F

    single_purchase_restriction

    single purchase restriction

    T : restrict single purchase
    F : do not restrict on single purchase

    DEFAULT F

    points_by_product

    whether use mileage individual setting

    F : use default setting
    T : individual setting

    DEFAULT F

    points_setting_by_payment

    mileage individual setting - lower level item > basic setting mileage or mileage setting according to payment method

    B : Use the default reserve setting
    C : Earn based on the payment method

    points_amount

    Mileage setting

    except_member_points

    Mileage exception

    T : exclude setting an additional mileage accumulation for member group
    F : do not setting an additional mileage accumulation for member group

    DEFAULT F

    main

    whether display at main

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

    relational_product

    Array Max : [200]

    Related product

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

    product_no
    Product number
    Required

    interrelated
    whether a related product as one-way or two-way
    Required

    T: one-way
    F: two-way
    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

    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.

    adult_certification

    Adult certification

    This attribute tell you whether the product is age-restricted or not. Customers need to authenticate themselves to purchase age-restricted products.

    You can enable age verification only when My Store > Store setup > General settings > Customers > Restrict order when age verification is on.

    This cannot be used on Cafe24 Vietnam, Philippines.

    T: Used
    F: Not used

    DEFAULT F

    exposure_limit_type

    types of customers allowed to view the relevant product

    A: display to all
    M: display to customers only

    DEFAULT A

    exposure_group_list

    customer levels allowed to view the relevant product

    Definition Copy
    Request example: Copy
    Response example:

    Update a bundleproduct

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    product_name

    Max Length : [250]

    Product name

    Name of product.

    bundle_product_components

    composite product information

    product_no
    composite product number
    Required

    purchase_quantity
    number of purchased bundles
    Required
    bundle_product_sales

    bundle discount information

    discount_value
    bundle discount price
    Required

    discount_type
    bundle discount type
    Required

    P: percentage-based
    V: fixed price-based

    discount_round_unit
    bundle discount round-off unit

    F: no round-off
    -2: to the nearest hundredth
    -1: to the nearest tenth
    0: to the nearest one
    1: to the nearest ten
    2: to the nearest hundred
    3: to the nearest thousand

    discount_round_type
    bundle discount round-off method

    F: round down
    R: round off
    C: round up
    display

    Whether display

    You can choose product should be displayed or not.

    T: Display
    F: Do not display

    selling

    whether selling

    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

    Used month for the product when product_condition is used product.

    add_category_no

    Category no

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

    category_no
    category number
    Required

    recommend
    whether a product is added to a recommended product category
    DEFAULT F
    T: added
    F: not added

    new
    whether a product is added to a new product category
    DEFAULT F
    T: added
    F: not added
    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.

    eng_product_name

    Max Length : [250]

    English name of product

    Name of product in english.

    supply_product_name

    Max Length : [250]

    Supplier product name

    internal_product_name

    Max Length : [50]

    internal product name

    model_name

    Max Length : [100]

    Model name

    Model name of product.

    use_naverpay

    whether use Naver Pay

    This cannot be used on Cafe24 Vietnam, Philippines.

    T: Used
    F: Not used

    naverpay_type

    Naver Pay sales type

    This cannot be used on Cafe24 Vietnam, Philippines.

    C : Naver Pay + Shopping Mall Products at the same time
    O : Naver Pay only products

    product_weight

    Min : [0]~Max : [999999.99]

    Weight of product

    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.

    use_icon_exposure_term

    whether use show date

    T: Used
    F: Not used

    icon_exposure_begin_datetime

    start date of show_date

    icon_exposure_end_datetime

    end date of show_date

    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.

    This cannot be used on Cafe24 Vietnam, Philippines.

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

    prepaid_shipping_fee

    Whether prepaid shipping fee

    This cannot be used on Cafe24 Vietnam, Philippines.

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

    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.

    minimum
    minimum date range
    DEFAULT 1

    maximum
    maximum date range
    DEFAULT 7
    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

    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)
    clearance_category_code

    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.

    key
    Additional field key
    Required

    value
    Additional field value
    price_content

    Max Length : [20]

    Alternative phrase of the selling price

    buy_limit_by_product

    whether purchase restriction individual setting

    T: use
    F: do not use

    buy_limit_type

    Purchase limitation

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

    buy_group_list

    customer levels allowed to purchase the relevant product

    repurchase_restriction

    repurchase restriction

    T : restrict repurchase
    F : do not restrict repurchase

    single_purchase_restriction

    single purchase restriction

    T : restrict single purchase
    F : do not restrict on single purchase

    points_by_product

    whether use mileage individual setting

    F : use default setting
    T : individual setting

    points_setting_by_payment

    mileage individual setting - lower level item > basic setting mileage or mileage setting according to payment method

    B : Use the default reserve setting
    C : Earn based on the payment method

    points_amount

    Mileage setting

    except_member_points

    Mileage exception

    T : exclude setting an additional mileage accumulation for member group
    F : do not setting an additional mileage accumulation for member group

    main

    whether display at main

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

    relational_product

    Array Max : [200]

    Related product

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

    product_no
    Product number

    interrelated
    whether a related product as one-way or two-way
    Required

    T: one-way
    F: two-way
    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

    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.

    adult_certification

    Adult certification

    This attribute tell you whether the product is age-restricted or not. Customers need to authenticate themselves to purchase age-restricted products.

    You can enable age verification only when My Store > Store setup > General settings > Customers > Restrict order when age verification is on.

    This cannot be used on Cafe24 Vietnam, Philippines.

    T: Used
    F: Not used

    exposure_limit_type

    types of customers allowed to view the relevant product

    A: display to all
    M: display to customers only

    exposure_group_list

    customer levels allowed to view the relevant product

    Definition Copy
    Request example: Copy
    Response example:

    Delete a bundleproduct

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Categories products

    A relational resource that lets you retrieve or update product display order or general display settings.

    Endpoints 
    GET /api/v2/admin/categories/{category_no}/products
GET /api/v2/admin/categories/{category_no}/products/count
POST /api/v2/admin/categories/{category_no}/products
PUT /api/v2/admin/categories/{category_no}/products
DELETE /api/v2/admin/categories/{category_no}/products/{product_no}

    Categories products properties

    Attribute Description
    shop_no

    Shop Number
    product_no

    Product number

    System assigned code. This code cannot be duplicated.
    sequence_no

    display order
    auto_sort

    whether to use automatic sorting
    sold_out

    Whether sold out or stock is available
    fixed_sort

    whether fixed
    not_for_sale

    whether not for sale
    display_group

    Min : [1]~Max : [3]

    detailed product category

    1 : Regular product
    2 : Recommend product
    3 : New product

    DEFAULT 1
    sequence

    Min : [1]~Max : [999998]

    Display order

    List all categories products

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    category_no
    Required

    Category number

    display_group
    Required

    Min : [1]~Max : [3]

    detailed product category

    1 : Regular product
    2 : Recommend product
    3 : New product

    limit

    Min : [1]~Max : [50000]

    Limit

    DEFAULT 50000

    Definition Copy
    Request example: Copy
    Response example:

    Count all categories products

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    category_no
    Required

    Category number

    display_group
    Required

    Min : [1]~Max : [3]

    detailed product category

    1 : Regular product
    2 : Recommend product
    3 : New product

    Definition Copy
    Request example: Copy
    Response example:

    Create a categories product

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    category_no
    Required

    Category number

    display_group

    Min : [1]~Max : [3]

    detailed product category

    1 : Regular product
    2 : Recommend product
    3 : New product

    DEFAULT 1

    product_no
    Required

    Product number

    Definition Copy
    Request example: Copy
    Response example:

    Update a categories product

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    category_no
    Required

    Category number

    display_group
    Required

    Min : [1]~Max : [3]

    detailed product category

    1 : Regular product
    2 : Recommend product
    3 : New product

    product_no
    Required

    Product number

    sequence

    Min : [1]~Max : [999999]

    Display order

    auto_sort

    whether to use automatic sorting

    T : Use automatic arrangement
    F : Do not use automatic arrangement

    fixed_sort

    whether fixed

    T : Use designated display order
    F : Do not use designated display order

    Definition Copy
    Request example: Copy
    Response example:

    Delete a categories product

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    category_no
    Required

    Category number

    product_no
    Required

    Product number

    display_group

    Min : [1]~Max : [3]

    detailed product category

    If a product is marked as [Not on display], it will not be displayed in new products or recommeded products section as well.

    1 : Regular product
    2 : Recommend product
    3 : New product

    DEFAULT 1

    Definition Copy
    Request example: Copy
    Response example:

    Mains products

    A relational resource to the Mains resource about main category products’ display order.

    Endpoints 
    GET /api/v2/admin/mains/{display_group}/products
GET /api/v2/admin/mains/{display_group}/products/count
POST /api/v2/admin/mains/{display_group}/products
PUT /api/v2/admin/mains/{display_group}/products
DELETE /api/v2/admin/mains/{display_group}/products/{product_no}

    Mains products properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    product_no

    Product number
    product_name

    Product name
    fixed_sort

    whether fixed

    List all mains products

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    display_group
    Required

    main category number

    Definition Copy
    Request example: Copy
    Response example:

    Count all mains products

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    display_group
    Required

    main category number

    Definition Copy
    Request example: Copy
    Response example:

    Create a mains product

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    display_group
    Required

    main category number

    product_no
    Required

    Product number

    Definition Copy
    Request example: Copy
    Response example:

    Update a mains product

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    display_group
    Required

    main category number

    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.

    Definition Copy
    Request example: Copy
    Response example:

    Delete a mains product

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    display_group
    Required

    main category number

    product_no
    Required

    Product number

    Definition Copy
    Request example: Copy
    Response example:

    Products

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

    Products has the following Resource as embedded Resource:
    ● Variants
    ● Hits
    ● Memos
    ● SEO

    Endpoints 
    GET /api/v2/admin/products
GET /api/v2/admin/products/count
GET /api/v2/admin/products/{product_no}
POST /api/v2/admin/products
PUT /api/v2/admin/products/{product_no}
DELETE /api/v2/admin/products/{product_no}

    Products properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    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".
    internal_product_name

    Max Length : [50]

    internal product name
    model_name

    Max Length : [100]

    Model name

    Model name of product
    price_excluding_tax

    product price (before VAT)
    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

    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

    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_by_product

    whether purchase restriction individual setting

    T: use
    F: do not use
    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_group_list

    customer levels allowed to purchase the relevant product
    repurchase_restriction

    repurchase restriction

    T : restrict repurchase
    F : do not restrict repurchase
    single_purchase_restriction

    single purchase restriction

    T : restrict single purchase
    F : do not restrict on single purchase
    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".
    points_by_product

    individual settings for points

    F : use default setting
    T : individual setting
    points_setting_by_payment

    points settings by payment method

    B : Use the default reserve setting
    C : Earn based on the payment method
    points_amount

    points settings information
    except_member_points

    omit additional points issued based on customer levels

    T : exclude setting an additional mileage accumulation for member group
    F : do not setting an additional mileage accumulation for member group
    product_volume

    product volume information
    adult_certification

    Adult certification

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

    T: Used
    F: Not used
    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
    use_naverpay

    whether use Naver Pay

    T: Used
    F: Not used
    naverpay_type

    Naver Pay sales type

    C : Naver Pay + Shopping Mall Products at the same time
    O : Naver Pay only products
    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.
    made_in_code

    Origin country code
    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 Resource


    Can search with using embed parameter.
    decorationimages

    Decoration Image Resource


    Can search with using embed parameter.
    benefits

    Benefits Resource


    Can search with using embed parameter.
    options

    Product Option Resource


    Can search with using embed parameter.
    variants

    Variants Resource


    Can search with using embed parameter.
    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.
    clearance_category_kor

    Korean product category for overseas customs clearance

    Product name as Korean
    clearance_category_code

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

    Clearance category code

    clearance_category_code
    additionalimages

    additional image resource


    Can search with using embed parameter.
    exposure_limit_type

    types of customers allowed to view the relevant product

    A: display to all
    M: display to customers only
    exposure_group_list

    customer levels allowed to view the relevant product
    set_product_type

    Product bundle type

    C: integral type. S: assembled type
    memos

    Memos Resource


    Can search with using embed parameter.
    hits

    Product hits Resource


    Can search with using embed parameter.
    seo

    Product Seo Resource


    Can search with using embed parameter.
    category

    Category number

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

    planned exhibition number
    description

    Detail description of product

    Detail description of product. You may input description with HTML.
    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.
    separated_mobile_description

    add mobile version

    T: add mobile version product details
    F: apply PC version product details
    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.
    payment_info

    Payment info

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

    Shipping info

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

    Exchange info

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

    Service info

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

    Vat tax info

    Displays text set at VAT text setting menu.
    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.
    simple_description

    Simple Product Description

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

    Product Tag Resource


    Can search with using embed parameter.
    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.

    T: Used
    F: Not used
    shipping_method

    Shipping method

    Following is the method when 'individual_delivery' is TRUE

    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

    C: Pay after delivery
    P: Prepaid
    B: Select Prepaid/Pay after delivery
    shipping_period

    Shipping period

    (When using 'Shipping charge individually') Average transit time for make a delivery.
    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_area

    Max Length : [255]

    Shipping area

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

    Shipping charge

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

    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
    origin_place_code

    Code of origin

    Code of origin
    additional_information

    Additional information list

    You may add additional information other than basic information.
    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

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

    whether display at main

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

    Array Max : [200]

    Related product

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

    List all products

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    discountprice
    embed

    Product discount sale price Resource


    Can search with using embed parameter.

    decorationimages
    embed

    Decoration Image Resource


    Can search with using embed parameter.

    benefits
    embed

    Benefits Resource


    Can search with using embed parameter.

    options
    embed

    Product Option Resource


    Can search with using embed parameter.

    variants
    embed

    Variants Resource

    Up to 100 variants can be retrieved per product.
    Either custom product code (custom_product_code) or custom variant code (custom_variant_code) is required.
    Can search with using embed parameter.

    additionalimages
    embed

    additional image resource


    Can search with using embed parameter.

    product_bundle

    Product bundle

    T: Use
    F: Do not use

    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no

    Product number

    Number of a product.

    You can search multiple item with ,(comma)

    display

    Whether display

    Search for products that displayed or not.

    selling

    whether selling

    Search for products that sell or not.

    product_name

    Product name

    Search for products of which names include the search query that you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    product_code

    Product code

    Search for products of which product codes include the search query that you enter. The search query is case-insensitive.

    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 of which product search terms or tags include the search query that you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    custom_product_code

    Custom product code

    Search for products of which custom product codes include the search query you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    custom_variant_code

    Custom variants code

    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

    Min : [0]
    Max : [2147483647]

    Minimum retail price

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

    retail_price_max

    Min : [0]
    Max : [2147483647]

    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 products added after the search start date. Must be used with a search end date. If the start date is the same as the end date, results will be retrieved based on the date.

    created_end_date

    timezone

    Registered date end

    Search for products added before the search end date. Must be used with a search start date. If the end date is the same as the start date, only results will be retrieved based on the date.

    updated_start_date

    timezone

    Updated date start

    Search for products edited after the search start date. Must be used with a search end date. If the start date is the same as the end date, results will be retrieved based on the date.

    updated_end_date

    timezone

    Updated date end

    Search for products edited before the search end date. Must be used with a search start date. If the end date is the same as the start date, results will be retrieved based on the date.

    category

    Category number

    Search for items that displayed at a certain category.

    eng_product_name

    English name of product

    Search for products of which product names (English) include the search query that you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    supply_product_name

    Supplier product name

    Search for products of which product names (supplier) include the search query that you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    internal_product_name

    internal product name

    You can search multiple item with ,(comma)

    model_name

    Model name

    Search for products of which model names include the search query that you enter. The search query is 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

    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 : [0]
    Max : [2147483647]

    Search after a certain product number

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

    ※ Cannot use below parameter when using this search condition.

    product_no
    sort
    order
    offset

    sort

    Sort order

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

    order

    Order by

    asc: Ascending
    desc: Descending

    offset

    Max : [5000]

    Start location of list

    Set the start location of search result.

    limit

    Min : [1]~Max : [100]

    Limit

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

    DEFAULT 10

    Definition Copy
    Request example: Copy
    Response example:

    Count all products

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no

    Product number

    Number of a product.

    You can search multiple item with ,(comma)

    display

    Whether display

    Search for products that displayed or not.

    selling

    whether selling

    Search for products that sell or not.

    product_name

    Product name

    Search for products of which names include the search query that you enter. The search query is 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 of which product search terms or tags include the search query that you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    custom_product_code

    Custom product code

    Search for products of which custom product codes include the search query that you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    custom_variant_code

    Custom variants code

    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

    Min : [0]
    Max : [2147483647]

    Minimum retail price

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

    retail_price_max

    Min : [0]
    Max : [2147483647]

    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 products added after the search start date. Must be used with a search end date. If the start date is the same as the end date, results will be retrieved based on the date.

    created_end_date

    timezone

    Registered date end

    Search for products added before the search end date. Must be used with a search start date. If the end date is the same as the start date, results will be retrieved based on the date.

    updated_start_date

    timezone

    Updated date start

    Search for products edited after the search start date. Must be used with a search end date. If the start date is the same as the end date, results will be retrieved based on the date.

    updated_end_date

    timezone

    Updated date end

    Search for products edited before the search end date. Must be used with a search start date. If the end date is the same as the start date, results will be retrieved based on the date.

    category

    Category number

    Search for items that displayed at a certain category.

    eng_product_name

    English name of product

    Search for products of which product names (English) include the search query that you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    supply_product_name

    Supplier product name

    Search for products of which product names (supplier) include the search query that you enter. The search query is case-insensitive.

    You can search multiple item with ,(comma)

    internal_product_name

    internal product name

    You can search multiple item with ,(comma)

    model_name

    Model name

    Search for products of which model names contain the search term that you enter. The search term is 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

    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 : [0]
    Max : [2147483647]

    Search after a certain product number

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

    ※ Cannot use below parameter when using this search condition.

    product_no
    sort
    order
    offset

    Definition Copy
    Request example: Copy
    Response example:

    Get a product

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    Number of a product.

    variants
    embed

    Variants Resource


    Can search with using embed parameter.

    memos
    embed

    Memos Resource


    Can search with using embed parameter.

    hits
    embed

    Product hits Resource


    Can search with using embed parameter.

    seo
    embed

    Product Seo Resource


    Can search with using embed parameter.

    tags
    embed

    Product Tag Resource


    Can search with using embed parameter.

    options
    embed

    Product Option Resource


    Can search with using embed parameter.

    discountprice
    embed

    Product discount sale price Resource


    Can search with using embed parameter.

    decorationimages
    embed

    Decoration Image Resource


    Can search with using embed parameter.

    benefits
    embed

    Benefits Resource


    Can search with using embed parameter.

    additionalimages
    embed

    additional image resource


    Can search with using embed parameter.

    Definition Copy
    Request example: Copy
    Response example:

    Create a product

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    display

    Whether display

    Whether display or not.

    T: Display
    F: Do not display

    DEFAULT F

    selling

    whether selling

    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

    Used month for the product when product_condition is used product.

    add_category_no

    Category no

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

    category_no
    category number
    Required

    recommend
    whether a product is added to a recommended product category
    DEFAULT F
    T: added
    F: not added

    new
    whether a product is added to a new product category
    DEFAULT F
    T: added
    F: not added
    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.

    supply_product_name

    Max Length : [250]

    Supplier product name

    internal_product_name

    Max Length : [50]

    internal product name

    model_name

    Max Length : [100]

    Model name

    Model name of product.

    price_excluding_tax

    Min : [0]~Max : [2147483647]

    product price (before VAT)

    If the base for price calculation (calculated_price_based_on) is "B (product price)" when retrieving product settings (GET:/products/setting), price_excluding_tax, not Price, should be used.

    price

    Min : [0]~Max : [2147483647]

    Product price

    Price of product.

    retail_price

    Min : [0]~Max : [2147483647]

    Product retail price

    supply_price
    Required

    Min : [0]~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

    options

    Option

    name
    Option name
    Required

    value
    Option value
    Required
    use_naverpay

    whether use Naver Pay

    This cannot be used on Cafe24 Vietnam, Philippines.

    T: Used
    F: Not used

    naverpay_type

    Naver Pay sales type

    This cannot be used on Cafe24 Vietnam, Philippines.

    C : Naver Pay + Shopping Mall Products at the same time
    O : Naver Pay only products

    manufacturer_code

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

    Manufacturer code

    Manufacturer code.

    DEFAULT M0000000

    trend_code

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

    Trend code

    DEFAULT T0000000

    brand_code

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

    Brand code

    DEFAULT B0000000

    supplier_code

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

    Supplier code

    shipping_fee: shipping

    DEFAULT S0000000

    product_weight

    Min : [0]~Max : [999999.99]

    Weight of product

    made_date

    Date of manufacture

    release_date

    Date of release

    expiration_date

    Array Max : [2]

    Expiration date

    Expiration date.

    start_date
    Start date of the term of validity

    end_date
    End date of the term of validity
    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.

    This cannot be used on Cafe24 Vietnam, Philippines.

    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

    DEFAULT F

    shipping_area

    Max Length : [255]

    Shipping area

    Shipping area.

    shipping_period

    Array Max : [2]

    Shipping period

    Transit time.

    minimum
    minimum date range
    DEFAULT 1

    maximum
    maximum date range
    DEFAULT 7
    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

    Array Max : [200]

    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

    shipping_rates_min
    minimum value in range for shipping fee charge option

    shipping_rates_max
    maximum value in range for shipping fee charge option

    shipping_fee
    shipping fee
    prepaid_shipping_fee

    Whether prepaid shipping fee

    This cannot be used on Cafe24 Vietnam, Philippines.

    C: Pay after delivery
    P: Prepaid
    B: Select Prepaid/Pay after 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)
    clearance_category_code

    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.

    key
    Additional field key
    Required

    value
    Additional field value
    price_content

    Max Length : [20]

    Alternative phrase of the selling price

    buy_limit_by_product

    whether purchase restriction individual setting

    T: use
    F: do not use

    DEFAULT F

    buy_limit_type

    Purchase limitation

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

    DEFAULT F

    buy_group_list

    customer levels allowed to purchase the relevant product

    repurchase_restriction

    repurchase restriction

    T : restrict repurchase
    F : do not restrict repurchase

    DEFAULT F

    single_purchase_restriction

    single purchase restriction

    T : restrict single purchase
    F : do not restrict on single purchase

    DEFAULT F

    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"

    points_by_product

    individual settings for points

    F : use default setting
    T : individual setting

    DEFAULT F

    points_setting_by_payment

    points settings by payment method

    B : Use the default reserve setting
    C : Earn based on the payment method

    points_amount

    points settings information

    payment_method
    payment method of mileage

    naverpay : naver pay
    smilepay : smile pay
    kakaopay : kakao pay
    payco : payco
    paynow : paynow
    kpay : k pay
    icash : virtual account
    deposit : deposit
    tcash : real time bank transfer
    cell : mobile phone
    card : card
    mileage : mileage
    cash : bank transfer

    points_rate
    Points issuance rate

    points_unit_by_payment
    unit of points by payment method

    P : percent unit
    W : Won unit
    except_member_points

    omit additional points issued based on customer levels

    T : exclude setting an additional mileage accumulation for member group
    F : do not setting an additional mileage accumulation for member group

    DEFAULT F

    product_volume

    product volume information

    use_product_volume
    Use product volume

    product_width
    width

    product_height
    depth

    product_length
    height
    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.

    made_in_code

    Origin country code

    A two-digit country code for country of origin
    Country code can be used instead of country of origin number (origin_place_no) and country of origin category (origin_classification).

    main

    whether display at main

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

    relational_product

    Array Max : [200]

    Related product

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

    product_no
    Product number
    Required

    interrelated
    whether a related product as one-way or two-way
    Required

    T: one-way
    F: two-way
    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.

    adult_certification

    Adult certification

    This attribute tell you whether the product is age-restricted or not. Customers need to authenticate themselves to purchase age-restricted products.

    You can enable age verification only when My Store > Store setup > General settings > Customers > Restrict order when age verification is on.

    This cannot be used on Cafe24 Vietnam, Philippines.

    T: Used
    F: Not used

    DEFAULT F

    exposure_limit_type

    types of customers allowed to view the relevant product

    A: display to all
    M: display to customers only

    DEFAULT A

    exposure_group_list

    customer levels allowed to view the relevant product

    Definition Copy
    Request example: Copy
    Response example:

    Update a product

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    display

    Whether display

    You can choose product should be displayed or not.

    T: Display
    F: Do not display

    selling

    whether selling

    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

    Used month for the product when product_condition is used product.

    add_category_no

    Category no

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

    category_no
    category number
    Required

    recommend
    whether a product is added to a recommended product category
    DEFAULT F
    T: added
    F: not added

    new
    whether a product is added to a new product category
    DEFAULT F
    T: added
    F: not added
    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.

    supply_product_name

    Max Length : [250]

    Supplier product name

    internal_product_name

    Max Length : [50]

    internal product name

    model_name

    Max Length : [100]

    Model name

    Model name of product.

    price_excluding_tax

    Min : [0]~Max : [2147483647]

    product price (before VAT)

    If the base for price calculation (calculated_price_based_on) is "B (product price)" when retrieving product settings (GET:/products/setting), price_excluding_tax, not Price, should be used.

    price

    Min : [0]~Max : [2147483647]

    Product price

    Price of product.

    retail_price

    Min : [0]~Max : [2147483647]

    Product retail price

    supply_price

    Min : [0]~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

    use_naverpay

    whether use Naver Pay

    This cannot be used on Cafe24 Vietnam, Philippines.

    T: Used
    F: Not used

    naverpay_type

    Naver Pay sales type

    This cannot be used on Cafe24 Vietnam, Philippines.

    C : Naver Pay + Shopping Mall Products at the same time
    O : Naver Pay only products

    manufacturer_code

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

    Manufacturer code

    Manufacturer code.

    trend_code

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

    Trend code

    brand_code

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

    Brand code

    supplier_code

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

    Supplier code

    Supplier code.

    product_weight

    Min : [0]~Max : [999999.99]

    Weight of product

    made_date

    Date of manufacture

    release_date

    Date of release

    expiration_date

    Array Max : [2]

    Expiration date

    Expiration date.

    start_date
    Start date of the term of validity

    end_date
    End date of the term of validity
    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

    use_icon_exposure_term

    whether use show date

    T: Used
    F: Not used

    icon_exposure_begin_datetime

    start date of show_date

    icon_exposure_end_datetime

    end date of show_date

    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.

    This cannot be used on Cafe24 Vietnam, Philippines.

    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

    Shipping period

    Transit time.

    minimum
    minimum date range
    DEFAULT 1

    maximum
    maximum date range
    DEFAULT 7
    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

    Array Max : [200]

    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

    shipping_rates_min
    minimum value in range for shipping fee charge option

    shipping_rates_max
    maximum value in range for shipping fee charge option

    shipping_fee
    shipping fee
    prepaid_shipping_fee

    Whether prepaid shipping fee

    This cannot be used on Cafe24 Vietnam, Philippines.

    C: Pay after delivery
    P: Prepaid
    B: Select Prepaid/Pay after 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)
    clearance_category_code

    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.

    key
    Additional field key
    Required

    value
    Additional field value
    price_content

    Max Length : [20]

    Alternative phrase of the selling price

    buy_limit_by_product

    whether purchase restriction individual setting

    T: use
    F: do not use

    buy_limit_type

    Purchase limitation

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

    buy_group_list

    customer levels allowed to purchase the relevant product

    repurchase_restriction

    repurchase restriction

    T : restrict repurchase
    F : do not restrict repurchase

    single_purchase_restriction

    single purchase restriction

    T : restrict single purchase
    F : do not restrict on single purchase

    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 for order.

    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"

    points_by_product

    individual settings for points

    F : use default setting
    T : individual setting

    points_setting_by_payment

    points settings by payment method

    B : Use the default reserve setting
    C : Earn based on the payment method

    points_amount

    points settings information

    payment_method
    payment method of mileage

    naverpay : naver pay
    smilepay : smile pay
    kakaopay : kakao pay
    payco : payco
    paynow : paynow
    kpay : k pay
    icash : virtual account
    deposit : deposit
    tcash : real time bank transfer
    cell : mobile phone
    card : card
    mileage : mileage
    cash : bank transfer

    points_rate
    Points issuance rate

    points_unit_by_payment
    unit of points by payment method

    P : percent unit
    W : Won unit
    except_member_points

    omit additional points issued based on customer levels

    T : exclude setting an additional mileage accumulation for member group
    F : do not setting an additional mileage accumulation for member group

    product_volume

    product volume information

    use_product_volume
    Use product volume

    product_width
    width

    product_height
    depth

    product_length
    height
    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.

    made_in_code

    Origin country code

    A two-digit country code for country of origin
    Country code can be used instead of country of origin number (origin_place_no) and country of origin category (origin_classification).

    main

    whether display at main

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

    relational_product

    Array Max : [200]

    Related product

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

    product_no
    Product number

    interrelated
    whether a related product as one-way or two-way
    Required

    T: one-way
    F: two-way
    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.

    adult_certification

    Adult certification

    This attribute tell you whether the product is age-restricted or not. Customers need to authenticate themselves to purchase age-restricted products.

    You can enable age verification only when My Store > Store setup > General settings > Customers > Restrict order when age verification is on.

    This cannot be used on Cafe24 Vietnam, Philippines.

    T: Used
    F: Not used

    exposure_limit_type

    types of customers allowed to view the relevant product

    A: display to all
    M: display to customers only

    exposure_group_list

    customer levels allowed to view the relevant product

    Definition Copy
    Request example: Copy
    Response example:

    Delete a product

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Products additionalimages

    Products additionalimages, a child resource of Products, lets you retrieve additional images of a product.

    Endpoints 
    POST /api/v2/admin/products/{product_no}/additionalimages
PUT /api/v2/admin/products/{product_no}/additionalimages

    Products additionalimages properties

    Attribute Description
    shop_no

    Shop Number
    additional_image

    Additional image

    Create a products additionalimage

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    additional_image
    Required

    Additional image

    ● Maximum number of requests: 20
    ● Maximum file size: 5MB
    ● Maximum file size per request : 30MB

    Definition Copy
    Request example: Copy
    Response example:

    Update a products additionalimage

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    additional_image
    Required

    Additional image

    ● Maximum number of requests: 20
    ● Maximum file size: 5MB
    ● Maximum file size per request : 30MB

    Definition Copy
    Request example: Copy
    Response example:

    Products approve

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

    Endpoints 
    GET /api/v2/admin/products/{product_no}/approve
POST /api/v2/admin/products/{product_no}/approve
PUT /api/v2/admin/products/{product_no}/approve

    Products approve properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    status
    Required

    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.

    Get products approve status

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    Definition Copy
    Request example: Copy
    Response example:

    Create a products approve

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    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

    Definition Copy
    Request example: Copy
    Response example:

    Update a products approve

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    Definition Copy
    Request example: Copy
    Response example:

    Products decorationimages

    This resource lets you add special images to products displayed on a store. This resource lets you retrieve decorative images from a store and add them to a certain product, or retrieve the images already added to a product.

    This resource can only be used as a child resource of the Products resource.

    Endpoints 
    GET /api/v2/admin/products/decorationimages
GET /api/v2/admin/products/{product_no}/decorationimages
POST /api/v2/admin/products/{product_no}/decorationimages
PUT /api/v2/admin/products/{product_no}/decorationimages
DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}

    Products decorationimages properties

    Attribute Description
    code

    code of decoration image
    path

    Decoration Image URL
    shop_no

    Shop Number
    use_show_date

    whether use show date

    T: Use
    F: Do not use
    show_start_date

    timezone

    start date of show_date
    show_end_date

    timezone

    end date of show_date
    image_list

    list of decoration image

    List all decoration images

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40
    Definition Copy
    Request example: Copy
    Response example:

    List all products decoration images

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Select decoration images to a product

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    use_show_date

    whether use show date

    T: Use
    F: Do not use

    show_start_date

    Date
    timezone

    start date of show_date

    show_end_date

    Date
    timezone

    end date of show_date

    image_list
    Required

    list of decoration image

    code
    decoration image code

    path
    decoration image path

    image_horizontal_position
    decoration image horizontal value

    image_vertical_position
    decoration image vertical value
    Definition Copy
    Request example: Copy
    Response example:

    Update a decoration images to a product

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    use_show_date

    whether use show date

    T: Use
    F: Do not use

    show_start_date

    Date
    timezone

    start date of show_date

    show_end_date

    Date
    timezone

    end date of show_date

    image_list
    Required

    list of decoration image

    code
    decoration image code

    path
    decoration image path

    image_horizontal_position
    decoration image horizontal value

    image_vertical_position
    decoration image vertical value
    Definition Copy
    Request example: Copy
    Response example:

    Deselect a decoration images to a product

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    code
    Required

    code of decoration image

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Products discountprice

    A resource about product's discount price. You can retrieve the discount price of products under the Benefits resource.

    This resource can only be used as a child resource of the Products resource. You can use the embed parameter in sending a request to retrieve product's discount price in one call.

    Endpoints 
    GET /api/v2/admin/products/{product_no}/discountprice

    Products discountprice properties

    Attribute Description
    pc_discount_price

    PC discount price
    mobile_discount_price

    Mobile discount price

    List all products discountprice

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    Definition Copy
    Request example: Copy
    Response example:

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

    Endpoints 
    GET /api/v2/admin/products/{product_no}/hits/count

    Count all products hits

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

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

    Endpoints 
    GET /api/v2/admin/products/icons
GET /api/v2/admin/products/{product_no}/icons
POST /api/v2/admin/products/{product_no}/icons
PUT /api/v2/admin/products/{product_no}/icons
DELETE /api/v2/admin/products/{product_no}/icons/{code}

    Products icons properties

    Attribute Description
    code

    code of product icon

    Code of Icon.
    path

    Path

    URL of Icon.
    shop_no

    Shop Number
    use_show_date

    whether use show date

    T: Use
    F: Do not use
    show_start_date

    timezone

    start date of show_date
    show_end_date

    timezone

    end date of show_date
    image_list

    list of product icon

    List all icons

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40
    Definition Copy
    Request example: Copy
    Response example:

    List all products icons

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Select product icons to a product

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    image_list
    Required

    Array Max : [5]

    list of product icon

    code
    code of product icon
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Update a product icons to a product

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    use_show_date

    whether use show date

    T: Use
    F: Do not use

    show_start_date

    Date
    timezone

    start date of show_date

    show_end_date

    Date
    timezone

    end date of show_date

    image_list

    Array Max : [5]

    list of product icon

    code
    code of product icon
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Deselect a product icons to a product

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    code
    Required

    code of product icon

    Definition Copy
    Request example: Copy
    Response example:

    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.

    Endpoints 
    POST /api/v2/admin/products/images
POST /api/v2/admin/products/{product_no}/images
DELETE /api/v2/admin/products/{product_no}/images

    Products images properties

    Attribute Description
    path

    Detail image
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    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 Images

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 20

    Request

    Parameter Description
    image
    Required

    Detail image

    Product image displayed on a product details page.

    ● Maximum file size: 5MB
    ● Maximum file size per request : 30MB

    Definition Copy
    Request example: Copy
    Response example:

    Upload product images

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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.

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products image

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

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

    Endpoints 
    GET /api/v2/admin/products/{product_no}/memos
GET /api/v2/admin/products/{product_no}/memos/{memo_no}
POST /api/v2/admin/products/{product_no}/memos
PUT /api/v2/admin/products/{product_no}/memos/{memo_no}
DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}

    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

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    limit

    Min : [1]~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

    Definition Copy
    Request example: Copy
    Response example:

    Get a products memo

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    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.

    Definition Copy
    Request example: Copy
    Response example:

    Create a products memo

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

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

    Definition Copy
    Request example: Copy
    Response example:

    Update a products memo

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

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

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products memo

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    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.

    Definition Copy
    Request example: Copy
    Response example:

    Products options

    This resource allows customers to select a variant for a product that comes in different colors or sizes. This resource has the option_name property, which can for example be color or size, and the option_value property, which can for example be red or yellow. Product variants are generated based on their options when they are added to a product.

    This resource can only be used as a child resource of the Products resource.

    Endpoints 
    GET /api/v2/admin/products/{product_no}/options
POST /api/v2/admin/products/{product_no}/options
PUT /api/v2/admin/products/{product_no}/options
DELETE /api/v2/admin/products/{product_no}/options

    Products options properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.
    has_option

    Whether the option is used

    T: Use
    F: Do not use
    option_type

    Type of option

    Shows type of option when "has_option" is TRUE.

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

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

    Option list type

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

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

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

    C: Integrated type
    S: Separated type
    option_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.
    options

    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: 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_options

    Additional option
    use_attached_file_option

    Whether use attached file option

    T: Use
    F: Do not use
    attached_file_option

    Attached file option

    List all products options

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Create a products option

    POST

    This resource lets you add new product options. Variants are automatically generated when new options are created.

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    options

    Option

    option_name
    Option name
    Required

    option_value Array
    Option value
    Required

    option_text
    Option value

    option_image_file
    swatch

    option_color
    colorchip

    option_display_type
    Option list type
    DEFAULT S
    S: select box
    P: preview
    B: text swatch
    R: radio button
    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_code

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

    Option set code

    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_options

    Additional option

    additional_option_name
    custom text field name
    Required

    additional_option_text_length
    character limit for custom text field
    Required

    1~30
    50
    100
    200

    required_additional_option
    whether a custom text field is required or optional
    Required
    DEFAULT T
    T: required
    F: optional
    use_attached_file_option

    Whether use attached file option

    T: Use
    F: Do not use

    attached_file_option

    Attached file option

    Definition Copy
    Request example: Copy
    Response example:

    Update a products option

    PUT

    This resource does not reset the variants while options are being updated. You can only update option names, option values as well as allow free-form options and file uploads. You cannot add new option variants or delete existing ones.

    If you want to add or delete options, you need to first delete them with Delete a products option resource and add them again.

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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.

    options

    Option

    option_name
    Option name
    Required

    option_value Array
    Option value

    option_text
    Option value

    option_image_file
    swatch

    option_link_image
    Option-linked image

    option_color
    colorchip

    option_display_type
    Option list type
    DEFAULT S
    S: select box
    P: preview
    B: text swatch
    R: radio button
    original_options

    Option value before modification

    option_name
    Option name
    Required

    option_value Array
    Option value
    Required

    option_text
    Option value
    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_options

    Additional option

    additional_option_name
    custom text field name
    Required

    additional_option_text_length
    character limit for custom text field
    Required

    1~30
    50
    100
    200

    required_additional_option
    whether a custom text field is required or optional
    Required
    DEFAULT T
    T: required
    F: optional
    use_attached_file_option

    Whether use attached file option

    T: Use
    F: Do not use

    attached_file_option

    Attached file option

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products option

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    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 Resource of the product, the Products SEO API can set search engine optimization of the target product.

    Endpoints 
    GET /api/v2/admin/products/{product_no}/seo
PUT /api/v2/admin/products/{product_no}/seo

    Products seo properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    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

    exposure setting for 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

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Update a products seo

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    exposure setting for search engine

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

    Definition Copy
    Request example: Copy
    Response example:

    Products tags

    This resource is about search keywords that can be added to a product so that search by these keyword can return that product. You can add new tags to a product so that it can be searched not only by the product name or product details but also by the keywords.

    This resource can only be used as a child resource of the Products resource.

    Endpoints 
    GET /api/v2/admin/products/{product_no}/tags
GET /api/v2/admin/products/{product_no}/tags/count
POST /api/v2/admin/products/{product_no}/tags
DELETE /api/v2/admin/products/{product_no}/tags/{tag}

    Products tags properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    tag

    Product tag

    Tag or keyword for product searching.
    tags
    Required

    Product tag
    product_no

    Product number

    System assigned code. This code cannot be duplicated.

    List all products tags

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Count all products tags

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    Definition Copy
    Request example: Copy
    Response example:

    Create a products tag

    POST

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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.

    tags
    Required

    Product tag

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products tag

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    tag

    Product tag

    Tag or keyword for product searching.

    Definition Copy
    Request example: Copy
    Response example:

    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.
    Products Variants has the following Resource as a embedded Resource:

    ● Inventories

    Endpoints 
    GET /api/v2/admin/products/{product_no}/variants
GET /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants
DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

    Products variants properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    variant_code

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

    Product item code

    System assigned code. This code cannot be duplicated.
    options

    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

    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

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

    whether use inventory

    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 display sold-out

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

    Available inventory
    safety_inventory

    minimum stock level
    inventories

    Inventories Resource

    Inventory Resource of variants.
    duplicated_custom_variant_code

    Whether duplicate custom variant code

    T: Duplicated
    F: Not duplicated
    product_no

    Product number

    System assigned code. This code cannot be duplicated.

    List all products variants

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    product_no
    Required

    Product number

    System assigned code. This code cannot be duplicated.

    inventories
    embed

    Inventories Resource

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

    You can search multiple item with ,(comma)

    Definition Copy
    Request example: Copy
    Response example:

    Get a products variant

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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 Resource


    Can search with using embed parameter.

    Definition Copy
    Request example: Copy
    Response example:

    Update a products variant

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    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

    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

    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 display sold-out

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

    safety_inventory

    minimum stock level

    Definition Copy
    Request example: Copy
    Response example:

    Update products variants(batch)

    PUT

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

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 100

    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

    T: Display
    F: Do not display

    selling

    whether selling

    T: Sell
    F: Do not sell

    additional_amount

    Additional price

    quantity

    Available inventory

    use_inventory

    whether use inventory

    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 display sold-out

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

    safety_inventory

    minimum stock level

    Definition Copy
    Request example: Copy
    Response example:

    Delete a products variant

    DELETE

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40

    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.

    Definition Copy
    Request example: Copy
    Response example:

    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.

    Endpoints 
    GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

    Products variants inventories properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    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

    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 display sold-out

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

    minimum stock level

    Get products variants inventory

    GET

    Specification

    Property Description
    SCOPE mall.read_product
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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.

    Definition Copy
    Request example: Copy
    Response example:

    Update a products variants inventory

    PUT

    Specification

    Property Description
    SCOPE mall.write_product
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    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 display sold-out

    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.

    safety_inventory

    minimum stock level

    Definition Copy
    Request example: Copy
    Response example:

    Collection

    Brands

    Brands refer to data entered in [Production information>Brand]. You can search products by brand and eveery product must be assigned to a brand (automatically assigned to “private brand” when unassigned.)

    Endpoints 
    GET /api/v2/admin/brands
GET /api/v2/admin/brands/count
POST /api/v2/admin/brands
PUT /api/v2/admin/brands/{brand_code}
DELETE /api/v2/admin/brands/{brand_code}

    Brands properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1
    brand_code

    Brand code
    brand_name

    Max Length : [50]

    Brand name
    use_brand

    whether to use a brand

    Whether the brand is being used

    T: Use
    F: Do not use
    search_keyword

    Max Length : [200]

    Search keyword
    product_count

    Product count

    Number of products
    created_date

    timezone

    Created date

    List all brands

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    T: Use
    F: Do not use

    limit

    Min : [1]~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

    Definition Copy
    Request example: Copy
    Response example:

    Count all brands

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    T: Use
    F: Do not use

    Definition Copy
    Request example: Copy
    Response example:

    Create a brand

    POST

    Specification

    Property Description
    SCOPE mall.write_collection
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    brand_name
    Required

    Brand name

    use_brand

    whether to use a brand

    T: Use
    F: Do not use

    DEFAULT T

    search_keyword

    Max Length : [200]

    Search keyword

    Definition Copy
    Request example: Copy
    Response example:

    Update a brand

    PUT

    Specification

    Property Description
    SCOPE mall.write_collection
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    brand_code
    Required

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

    Brand code

    brand_name

    Brand name

    use_brand

    whether to use a brand

    T: Use
    F: Do not use

    DEFAULT T

    search_keyword

    Max Length : [200]

    Search keyword

    Definition Copy
    Request example: Copy
    Response example:

    Delete a brand

    DELETE

    Specification

    Property Description
    SCOPE mall.write_collection
    Request Limit 40

    Request

    Parameter Description
    brand_code
    Required

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

    Brand code

    Definition Copy
    Request example: Copy
    Response example:

    Classifications

    Custom category refers to information entered in [Products>Add products>Advanced settings>Production information>Custom category]. It is one of the category types and every product must be assigned to one custom category. If a product is unassigned, it is automatically assigned to Default custom category.

    Endpoints 
    GET /api/v2/admin/classifications
GET /api/v2/admin/classifications/count

    Classifications properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    classification_code

    Type : [A-Z0-9]
    Min Length : [8]
    Max 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

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    Min : [1]~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

    Definition Copy
    Request example: Copy
    Response example:

    Count all classifications

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    Definition Copy
    Request example: Copy
    Response example:

    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)

    Endpoints 
    GET /api/v2/admin/manufacturers
GET /api/v2/admin/manufacturers/count
GET /api/v2/admin/manufacturers/{manufacturer_code}
POST /api/v2/admin/manufacturers
PUT /api/v2/admin/manufacturers/{manufacturer_code}

    Manufacturers properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    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

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    Min : [1]~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.

    Definition Copy
    Request example: Copy
    Response example:

    Count all manufacturers

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    manufacturer_code

    Manufacturer code

    Code of the manufacturer you want to retrieve

    You can search multiple item with ,(comma)

    manufacturer_name

    Manufacturer name

    Search for manufacturers of which names contain the search term that you enter. The search term is case-insensitive.

    You can search multiple item with ,(comma)

    use_manufacturer

    Use manufacturer

    T: Use
    F: Do not use

    Definition Copy
    Request example: Copy
    Response example:

    Get a manufacturer

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    manufacturer_code
    Required

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

    Manufacturer code

    Definition Copy
    Request example: Copy
    Response example:

    Create a manufacturer

    POST

    Specification

    Property Description
    SCOPE mall.write_collection
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    manufacturer_name
    Required

    Manufacturer name

    president_name
    Required

    Max Length : [30]

    CEO

    email

    Max Length : [255]
    Email

    Email

    phone

    Max Length : [20]
    Phone Number

    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

    Definition Copy
    Request example: Copy
    Response example:

    Update a manufacturer

    PUT

    Specification

    Property Description
    SCOPE mall.write_collection
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    manufacturer_code
    Required

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

    Manufacturer code

    manufacturer_name

    Manufacturer name

    president_name

    CEO

    email

    Max Length : [255]
    Email

    Email

    phone

    Max Length : [20]
    Phone Number

    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

    Definition Copy
    Request example: Copy
    Response example:

    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.

    Endpoints 
    GET /api/v2/admin/origin

    Origin properties

    Attribute Description
    origin_place_no

    Origin place no
    origin_place_name

    Origin place name
    foreign

    Foreign
    made_in_code

    Origin country code

    List all origin

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    origin_place_no

    Origin place no

    origin_place_name

    Max Length : [50]

    Origin place name

    foreign

    Foreign

    limit

    Min : [1]~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

    Definition Copy
    Request example: Copy
    Response example:

    Trends refers to the information that you enter into trends in the "production information" of a product. Trends is one of the sales categories that distinguish products, and products must have one trend (using "basic trends" when not specified).

    Endpoints 
    GET /api/v2/admin/trends
GET /api/v2/admin/trends/count
    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    trend_code

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

    Trend code
    trend_name

    Max Length : [50]

    Trend name
    use_trend

    whether to use trend

    Whether use trend or not.

    T: Use
    F: Do not use
    created_date

    timezone

    Created date
    product_count

    Product count

    Number of products.
    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    trend_code

    Trend code

    Code of trend.

    You can search multiple item with ,(comma)

    trend_name

    Trend name

    Name of trend.

    You can search multiple item with ,(comma)

    use_trend

    whether to use trend

    Whether use trend or not.

    T: Use
    F: Do not use

    limit

    Min : [1]~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

    GET

    Specification

    Property Description
    SCOPE mall.read_collection
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    trend_code

    Trend code

    You can search multiple item with ,(comma)

    trend_name

    Trend name

    You can search multiple item with ,(comma)

    use_trend

    whether to use trend

    Whether use trend or not.

    T: Use
    F: Do not use

    Supply

    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)

    Endpoints 
    GET /api/v2/admin/suppliers
GET /api/v2/admin/suppliers/count
GET /api/v2/admin/suppliers/{supplier_code}
POST /api/v2/admin/suppliers
PUT /api/v2/admin/suppliers/{supplier_code}
DELETE /api/v2/admin/suppliers/{supplier_code}

    Suppliers properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    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: Do not set
    C: Daily term
    B: Weekly term
    A: Monthly term
    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

    registered date

    Created date of supplier information.
    updated_date

    timezone

    Updated date

    Modified date of supplier information.
    country_code

    Country code of business address

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    ETC: Others
    zipcode

    Max Length : [10]

    Zipcode

    Zipcode of supplier.
    address1

    Max Length : [255]

    Address 1

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

    Max Length : [255]

    Address 2

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

    In Charge

    Person in charge at supplier.
    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

    Criteria status for payment.
    10 : Complete payment
    30 : Start shipping
    40 : Shipping complete

    It can be displayed only in detail inquiry.

    10 : complete payment
    30 : delivery start
    40 : delivered
    payment_start_day

    Min : [0]~Max : [6]

    Payment start day

    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: Sunday
    1: Monday
    2: Tuesday
    3: Wednesday
    4: Thursday
    5: Friday
    6: Saturday
    payment_end_day

    Min : [0]~Max : [6]

    Payment end day

    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: Sunday
    1: Monday
    2: Tuesday
    3: Wednesday
    4: Thursday
    5: Friday
    6: Saturday
    payment_start_date

    Min : [1]~Max : [31]

    payment start date

    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]

    payment end date

    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.

    bank_code

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

    Country code of market address

    It can be displayed only in detail inquiry.

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    ETC: Others
    market_zipcode

    Max Length : [10]

    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_country_code

    Country code of return address

    It can be displayed only in detail inquiry.

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    ETC: Others
    exchange_zipcode

    Max Length : [10]

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

    show 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

    About us

    A brief introduction of the supplier.

    It can be displayed only in detail inquiry.

    List all suppliers

    GET

    Specification

    Property Description
    SCOPE mall.read_supply
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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

    Min : [1]~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

    Definition Copy
    Request example: Copy
    Response example:

    Count all suppliers

    GET

    Specification

    Property Description
    SCOPE mall.read_supply
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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)

    Definition Copy
    Request example: Copy
    Response example:

    Get a supplier

    GET

    Specification

    Property Description
    SCOPE mall.read_supply
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    supplier_code
    Required

    Supplier code

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

    Definition Copy
    Request example: Copy
    Response example:

    Create a supplier

    POST

    Specification

    Property Description
    SCOPE mall.write_supply
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    supplier_name
    Required

    Max Length : [50]

    Supplier name

    Name of supplier. Supplier name is the basic information for mall to distinguish each supplier.

    manager_information

    Array Max : [3]

    In Charge

    You can add up to three managers.

    no
    manager serial code
    Required

    name
    manager name
    Required

    phone
    manager contact

    email
    manager email
    use_supplier

    Use classification

    Whether use the supplier or not.

    T: Use
    F: Do not use

    DEFAULT T

    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.

    D: Reatil
    C: Direct shipping

    DEFAULT D

    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

    DEFAULT WS

    status

    Approval status

    Business status information with corresponding supplier.

    A: Business on going
    P: On hold
    N: Business terminated

    DEFAULT 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

    DEFAULT P

    payment_period

    Payment frequency term

    You can set the payment frequency term.

    0: Do not set
    C: Daily term
    B: Weekly term
    A: Monthly term

    payment_method

    criteria status for payment

    Criteria status for payment.
    10 : Complete payment
    30 : Start shipping
    40 : Shipping complete

    10 : complete payment
    30 : delivery start
    40 : delivered

    payment_start_day

    Min : [0]~Max : [6]

    Payment start day

    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

    0: Sunday
    1: Monday
    2: Tuesday
    3: Wednesday
    4: Thursday
    5: Friday
    6: Saturday

    payment_end_day

    Min : [0]~Max : [6]

    Payment end day

    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

    0: Sunday
    1: Monday
    2: Tuesday
    3: Wednesday
    4: Thursday
    5: Friday
    6: Saturday

    payment_start_date

    Min : [1]~Max : [31]

    payment start date

    Set the payment start date in case for Payment frequency term is Monthly term(A)

    payment_end_date

    Min : [1]~Max : [31]

    payment end date

    Set the payment end date in case for Payment frequency term is Monthly term(A)

    commission

    commission rate

    Commission information for commission payment type(P).

    DEFAULT 10

    phone

    Max Length : [20]
    Phone Number

    Office phone number

    Office phone number of supplier.

    fax

    Max Length : [20]
    Phone Number

    Office fax number

    Office fax number of supplier.

    country_code

    Country code of business address

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    VNM : Vietnam
    ETC: Others

    zipcode

    Max Length : [10]

    Zipcode

    Zipcode of supplier.

    address1

    Max Length : [255]

    Address 1

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

    address2

    Max Length : [255]

    Address 2

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

    market_country_code

    Country code of market address

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    VNM : Vietnam
    ETC: Others

    market_zipcode

    Max Length : [10]

    Market address zip code

    market_address1

    Market address 1

    market_address2

    Market address 2

    exchange_country_code

    Country code of return address

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    VNM : Vietnam
    ETC: Others

    exchange_zipcode

    Max Length : [10]

    Return address zip code

    exchange_address1

    Max Length : [255]

    Return address 1

    exchange_address2

    Max Length : [255]

    Return address 2

    homepage_url

    Max Length : [100]

    Home page address

    mall_url

    Max Length : [100]

    Shopping mall address

    account_start_date

    Max Length : [10]
    Date

    Transaction start date

    account_stop_date

    Max Length : [10]
    Date

    Transaction stop date

    memo

    Max Length : [255]

    Important memo

    Memo for manage supplier.

    company_registration_no

    Max Length : [12]
    Business Number

    Company registration number

    Business registration number with corresponding supplier. Displays when unique business registration number issued following to a country.

    company_name

    Max Length : [30]

    Company name

    Company name that supplier registered when registration of enterprise.

    president_name

    Max Length : [20]

    CEO

    President name that supplier registered when registration of enterprise.

    company_condition

    Max Length : [20]

    Business

    Company type that supplier registered when registration of enterprise.

    company_line

    Max Length : [20]

    Business category

    Company item that supplier registered when registration of enterprise.

    company_introduction

    About us

    A brief introduction of the supplier.

    Definition Copy
    Request example: Copy
    Response example:

    Update a supplier

    PUT

    Specification

    Property Description
    SCOPE mall.write_supply
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    supplier_code
    Required

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

    Supplier code

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

    supplier_name

    Max Length : [50]

    Supplier name

    Name of supplier. Supplier name is the basic information for mall to distinguish each supplier.

    use_supplier

    Use classification

    Whether use the supplier or not.

    T: Use
    F: Do not use

    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.

    D: Reatil
    C: Direct shipping

    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

    status

    Approval status

    Business status information with corresponding supplier.

    A: Business on going
    P: On hold
    N: Business terminated

    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

    payment_period

    Payment frequency term

    You can set the payment frequency term.

    0: Do not set
    C: Daily term
    B: Weekly term
    A: Monthly term

    commission

    commission rate

    Commission information for commission payment type(P).

    manager_information

    Array Max : [3]

    In Charge

    You can add up to three managers. Information on a specific manager can be edited by using "no".

    no
    manager serial code
    Required

    name
    manager name
    Required

    phone
    manager contact

    email
    manager email

    use_sms
    Whether to receive SMS

    T: Receive
    F: Do not receive
    business_item

    Max Length : [255]

    Product type for business

    Product type of business dealing with supplier.

    payment_method

    criteria status for payment

    Criteria status for payment.
    10 : Complete payment
    30 : Start shipping
    40 : Shipping complete

    10 : complete payment
    30 : delivery start
    40 : delivered

    payment_start_day

    Min : [0]~Max : [6]

    Payment start day

    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

    0: Sunday
    1: Monday
    2: Tuesday
    3: Wednesday
    4: Thursday
    5: Friday
    6: Saturday

    payment_end_day

    Min : [0]~Max : [6]

    Payment end day

    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

    0: Sunday
    1: Monday
    2: Tuesday
    3: Wednesday
    4: Thursday
    5: Friday
    6: Saturday

    payment_start_date

    Min : [1]~Max : [31]

    payment start date

    Set the payment start date in case for Payment frequency term is Monthly term(A)

    payment_end_date

    Min : [1]~Max : [31]

    payment end date

    Set the payment end date in case for Payment frequency term is Monthly term(A)

    phone

    Max Length : [20]
    Phone Number

    Office phone number

    Office phone number of supplier.

    fax

    Max Length : [20]
    Phone Number

    Office fax number

    Office fax number of supplier.

    country_code

    Country code of business address

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    VNM : Vietnam
    ETC: Others

    zipcode

    Max Length : [10]

    Zipcode

    Zipcode of supplier.

    address1

    Max Length : [255]

    Address 1

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

    address2

    Max Length : [255]

    Address 2

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

    market_country_code

    Country code of market address

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    VNM : Vietnam
    ETC: Others

    market_zipcode

    Max Length : [10]

    Market address zip code

    market_address1

    Market address 1

    market_address2

    Market address 2

    exchange_country_code

    Country code of return address

    KOR: Korea
    JPN: Japan
    CHN: China
    TWN: Taiwan
    VNM : Vietnam
    ETC: Others

    exchange_zipcode

    Max Length : [10]

    Return address zip code

    exchange_address1

    Max Length : [255]

    Return address 1

    exchange_address2

    Max Length : [255]

    Return address 2

    homepage_url

    Max Length : [100]

    Home page address

    mall_url

    Max Length : [100]

    Shopping mall address

    account_start_date

    Max Length : [10]
    Date

    Transaction start date

    account_stop_date

    Max Length : [10]
    Date

    Transaction stop date

    memo

    Max Length : [255]

    Important memo

    Memo for manage supplier.

    company_registration_no

    Max Length : [12]
    Business Number

    Company registration number

    Business registration number with corresponding supplier. Displays when unique business registration number issued following to a country.

    company_name

    Max Length : [30]

    Company name

    Company name that supplier registered when registration of enterprise.

    president_name

    Max Length : [20]

    CEO

    President name that supplier registered when registration of enterprise.

    company_condition

    Max Length : [20]

    Business

    Company type that supplier registered when registration of enterprise.

    company_line

    Max Length : [20]

    Business category

    Company item that supplier registered when registration of enterprise.

    company_introduction

    About us

    A brief introduction of the supplier.

    Definition Copy
    Request example: Copy
    Response example:

    Delete a supplier

    DELETE

    Specification

    Property Description
    SCOPE mall.write_supply
    Request Limit 40

    Request

    Parameter Description
    supplier_code
    Required

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

    Supplier code

    Definition Copy
    Request example: Copy
    Response example:

    Suppliers users

    Supplier Users is used when the supplier logs in to the shopping mall and registers the goods directly. You can grant limited rights to supplier operators such as uploading products, managing classifications, and managing bulletin boards.

    Endpoints 
    GET /api/v2/admin/suppliers/users
GET /api/v2/admin/suppliers/users/count
GET /api/v2/admin/suppliers/users/{user_id}

    Suppliers users properties

    Attribute Description
    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    Supplier operator ID

    ID of supplier operator when logging in the mall. Supplier operator can access the supplier administrator screen by logging in to the shopping mall administrator page same as the sub operator of the mall.
    supplier_code

    Max Length : [8]

    Supplier code

    System assigned code of supplier. This code cannot be duplicated.
    supplier_name

    Max Length : [100]

    Supplier name

    Name of supplier is a basic information which can separate each supplier at the shopping mall administrator page.
    permission_category_select

    Authority to select the classification when a product is registered

    Set the authority of whether the supplier operator can select the product classification when register product.

    Allow : The supplier operator can register the product by selecting it within the specified product category when registering the product.
    Do not allow : A supplier operator cannot select a product category when registering a product.

    T: Allow
    F: Do not allow
    permission_product_modify

    Authority to modify a product

    Permission of modify the product for supplier operator after register the product.

    T: Allow
    F: Do not allow
    permission_product_display

    Authority to display a product

    Permission of display the product for supplier operator after register the product.

    T: Allow
    F: Do not allow
    permission_product_selling

    Authority to sell a product

    Permission of selling the product for supplier operator after register the product.

    T: Allow
    F: Do not allow
    permission_product_delete

    Permission to remove registered products

    Permission of delete the product for supplier operator after register the product.

    T: Allow
    F: Do not allow
    permission_board_manage

    authority setting for board

    Permission of access bulletin board for supplier operator after register the product.

    T: Allow
    F: Do not allow
    user_name

    Suppliers/Users name

    Name of the supplier's operator means the name displayed in the "person (processor) who performed the job" when a supplier operator performs a certain operation on the shopping mall manager screen.
    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.
    nick_name

    Length Min : [4]~Max : [20]

    Nick name

    The nickname of the supplier's operator displayed in the "Writer" section if the operator of the supplier creates a post on the bulletin board. (only if the bulletin board is set to expose the 'nickname' instead of the writer name)
    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.
    nick_name_icon_type

    Nickname icon type of supplier operator

    Can select type for Icon that shows in front of supplier operator nickname.

    Register Icon personally : Can upload & set the nickname Icon personally.
    Register sample Icon : Can select & set the nickname Icon which provided already.
    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.

    D: Register Icon personally
    S: Register sample Icon
    nick_name_icon_url

    Max Length : [255]

    Nickname icon url of supplier operator

    Image path of supplier operator's nickname icon

    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.
    use_nick_name_icon

    Nickname icon display setting

    Whether display nickname icon or not when supplier operator creates a post on the bulletin board.

    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.

    T: Display
    F: Do not display
    use_writer_name_icon

    Board writer display setting

    Whether display writer's name or not when supplier operator creates a post on the bulletin board.

    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.

    T: Display
    F: Do not display
    email

    Email

    Email address of supplier operator. Can be used for store of supplier's contact information.

    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.
    phone

    Office phone number

    Phone number of supplier operator. Can be used for store of supplier's contact information.

    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.
    permission_shop_no

    Number of multi shopping mall

    A unique number assigned to a store using the default store language or other languages

    It can be displayed only in detail inquiry.
    permitted_category_list

    Permission of classification access

    A product category that a supplier operator can select when registering a product. The supplier operator can upload the product only to the product category of selectable when registering the product.

    Can be checked only in the 'Search supplier operator detail' API.

    It can be displayed only in detail inquiry.

    List all suppliers users

    GET

    Specification

    Property Description
    SCOPE mall.read_supply
    Request Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    Supplier operator ID

    ID of supplier operator when logging in the mall. Supplier operator can access the supplier administrator screen by logging in to the shopping mall administrator page same as the sub operator of the mall.

    supplier_code

    Max Length : [8]

    Supplier code

    System assigned code of supplier. This code cannot be duplicated.

    supplier_name

    Max Length : [100]

    Supplier name

    Name of supplier is a basic information which can separate each supplier at the shopping mall administrator page.

    Definition Copy
    Request example: Copy
    Response example:

    Count all suppliers users

    GET

    Specification

    Property Description
    SCOPE mall.read_supply
    Request Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    Supplier operator ID

    ID of supplier operator when logging in the mall. Supplier operator can access the supplier administrator screen by logging in to the shopping mall administrator page same as the sub operator of the mall.

    supplier_code

    Max Length : [8]

    Supplier code

    System assigned code of supplier. This code cannot be duplicated.

    supplier_name

    Max Length : [100]

    Supplier name

    Name of supplier is a basic information which can separate each supplier at the shopping mall administrator page.

    Definition Copy
    Request example: Copy
    Response example:

    Get a suppliers user

    GET

    Specification

    Property Description
    SCOPE mall.read_supply
    Request Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    user_id

    Type : [a-zA-Z0-9]
    Max Length : [20]

    Supplier operator ID

    ID of supplier operator when logging in the mall. Supplier operator can access the supplier administrator screen by logging in to the shopping mall administrator page same as the sub operator of the mall.

    Definition Copy
    Request example: Copy
    Response example:

    Personal

    Carts

    Endpoints 
    GET /api/v2/admin/carts

    Carts properties

    Attribute Description
    shop_no

    Shop Number
    basket_product_no

    cart item number
    member_id

    Member id
    created_date

    timezone

    date of deposition
    product_no

    Product number
    additional_option_values

    Additional option
    variant_code

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

    Product item code
    quantity

    Available inventory
    product_price

    Product price
    option_price

    Option price
    product_bundle

    Product bundle

    T: Set product
    F: No set product
    shipping_type

    Delivery type

    A: Domestic
    B: Overseas
    category_no

    Category number

    List all carts

    GET

    Specification

    Property Description
    SCOPE mall.read_personal
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    member_id
    Required

    Member id

    You can search multiple item with ,(comma)

    offset

    Max : [10000]

    Start location of list

    limit

    Min : [1]~Max : [100]

    Limit

    DEFAULT 10

    Definition Copy
    Request example: Copy
    Response example:

    Customers wishlist

    Customers wishlist is a relational resource that lets you retrieve a list of products in a customer's wishlist.

    Endpoints 
    GET /api/v2/admin/customers/{member_id}/wishlist
GET /api/v2/admin/customers/{member_id}/wishlist/count

    Customers wishlist properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    wishlist_no

    number of a wishlist product
    product_no

    Product number
    variant_code

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

    Variant code

    System assigned code. This code cannot be duplicated.
    additional_option

    Additional option
    attached_file_option

    Attached file option
    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 ]
    product_bundle

    Product bundle
    created_date

    timezone

    date of deposition

    Date when an item was added to the wishlist.
    price_content

    Max Length : [20]

    Alternative phrase of the selling price

    List all customers wishlist

    GET

    Search a list of wishlist products of a customer.

    Specification

    Property Description
    SCOPE mall.read_personal
    Request Limit 40

    Request

    Parameter Description
    member_id
    Required

    Member id

    shop_no

    Shop Number

    DEFAULT 1

    Definition Copy
    Request example: Copy
    Response example:

    Count all customers wishlist

    GET

    Count wishlist products of a customer.

    Specification

    Property Description
    SCOPE mall.read_personal
    Request Limit 40

    Request

    Parameter Description
    member_id
    Required

    Member id

    shop_no

    Shop Number

    DEFAULT 1

    Definition Copy
    Request example: Copy
    Response example:

    Products carts

    Endpoints 
    GET /api/v2/admin/products/{product_no}/carts
GET /api/v2/admin/products/{product_no}/carts/count

    Products carts properties

    Attribute Description
    shop_no

    Shop Number
    member_id

    Member id
    created_date

    timezone

    date of deposition
    product_no

    Product number
    variant_code

    Product item code
    quantity

    Available inventory
    product_bundle

    Product bundle

    T: Set product
    F: No set product

    List all products carts

    GET

    Specification

    Property Description
    SCOPE mall.read_personal
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    limit

    Min : [1]~Max : [100]

    Limit

    DEFAULT 10

    offset

    Max : [10000]

    Start location of list

    Definition Copy
    Request example: Copy
    Response example:

    Count all products carts

    GET

    Specification

    Property Description
    SCOPE mall.read_personal
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    product_no
    Required

    Product number

    Definition Copy
    Request example: Copy
    Response example:

    Order

    Cancellation

    Endpoints 
    GET /api/v2/admin/cancellation/{claim_code}
POST /api/v2/admin/cancellation

    Cancellation properties

    Attribute Description
    shop_no

    Min : [1]

    Shop Number
    order_id

    Order ID
    claim_code

    cancellation number
    claim_reason_type

    division

    It can be displayed only in detail inquiry.

    A: change of mind
    B: shipping delay
    J: shipping error
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    K: defective product
    G: dissatisfied with service
    H: out of stock
    I: others
    claim_reason

    Reason

    It can be displayed only in detail inquiry.
    refund_method

    Refund method

    It can be displayed only in detail inquiry.
    refund_reason

    Remarks

    It can be displayed only in detail inquiry.
    order_price_amount

    Purchase amount

    It can be displayed only in detail inquiry.
    refund_amount

    refund amount

    It can be displayed only in detail inquiry.
    shipping_fee

    shipping fee

    It can be displayed only in detail inquiry.
    return_ship_type

    Return shipping cost classification

    It can be displayed only in detail inquiry.
    defer_commission

    Postpayment Fee

    It can be displayed only in detail inquiry.
    partner_discount_amount

    Affiliate discount cancellation amount

    It can be displayed only in detail inquiry.
    add_discount_amount

    Extra discount discount by product

    It can be displayed only in detail inquiry.
    member_grade_discount_amount

    Membership Discount Discount Amount

    It can be displayed only in detail inquiry.
    shipping_discount_amount

    Shipping discount cancellation amount

    It can be displayed only in detail inquiry.
    coupon_discount_amount

    Coupon discount cancellation amount

    It can be displayed only in detail inquiry.
    point_used

    Reimbursement Return Used

    It can be displayed only in detail inquiry.
    credit_used

    Deposit Refund Used

    It can be displayed only in detail inquiry.
    items

    Order item code
    status

    Order status

    canceled : canceled

    Get a cancellation

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    claim_code
    Required

    Cancellation number

    Definition Copy
    Request example: Copy
    Response example:

    Create cancellation

    POST

    This API allows you to process cancellations for multiple orders awaiting shipment. When cancellations are processed by using this API, orders will be marked as canceled, but you need to cancel payments via payment gateways.

    For partial cancellations, refund amount for each order will be automatically calculated and processed.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 100

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    status
    Required

    Order status

    canceled : canceled

    recover_inventory

    Inventory Recovery

    T : Recover
    F : Do not recover

    DEFAULT F

    recover_coupon

    restore a coupon

    Unavailable for marketplace or NAVER Pay order cancellations

    T : Recover
    F : Do not recover

    DEFAULT F

    add_memo_too

    add to admin memo

    Unavailable for marketplace or NAVER Pay order cancellations

    T: Enable
    F: Disable

    DEFAULT F

    reason

    Max Length : [2000]

    reason for cancellation

    claim_reason_type

    type of reason for cancellation

    Unavailable for marketplace or NAVER Pay order cancellations

    A: change of mind
    B: shipping delay
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    G: dissatisfied with service
    H: out of stock
    I: others

    naverpay_cancel_reason_type

    reason for NAVER Pay order cancellation

    Unavailable for Cafe24 store or marketplace order cancellations

    This cannot be used on Cafe24 Vietnam, Philippines.

    51 : change of mind
    52 : change color or size
    53 : bought by mistake
    54 : dissatisfied with service or product
    55 : delay in shipping
    56 : out of stock
    60 : different from product details

    refund_method_code

    Refund method

    T : cash
    F : credit card
    M : points
    G : bank transfer
    C : mobile
    D : credits
    Z : COD
    O : digital wallet balance
    V : convenience store
    I : others

    combined_refund_method

    Mixed refund methods

    When credit card, bank transfer or mobile payment is selected as refund method (refund_method_code), another payment method that will be used to receive refunds for an order paid with multiple payment methods can be selected.

    Note that when the refund amount is smaller than the amount paid via payment gateway, total refund will be processed via the main payment method.

    T : cash
    M : points
    D : credits

    refund_bank_code

    code assigned to bank for refunds

    Required when refund method (refund_method) is set as cash (T)

    refund_bank_code

    Required for Korean stores
    Available only when refund method (refund_method) is set as cash (T)
    Unavailable for marketplace or NAVER Pay order cancellations

    refund_bank_name

    Max Length : [250]

    Bank name

    Required when refund method (refund_method) is set as cash (T)

    Required for international stores

    Available only when refund method (refund_method) is set as cash (T)
    Unavailable for marketplace or NAVER Pay order cancellations

    refund_bank_account_no

    Max Length : [50]

    Refund account number

    Available only when refund method (refund_method) is set as cash (T)
    Unavailable for marketplace or NAVER Pay order cancellations

    refund_bank_account_holder

    Max Length : [15]

    Refund Account Account Holder's Name

    items

    Order item code

    order_item_code
    Order item code
    Required

    quantity
    Available inventory
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Cashreceipt

    Endpoints 
    GET /api/v2/admin/cashreceipt
POST /api/v2/admin/cashreceipt
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

    Cashreceipt properties

    Attribute Description
    cashreceipt_no

    Cash receipt number
    approval_no

    Approval Number
    request_date

    Date requested
    order_id

    Order ID
    member_id

    Member id
    name

    Requester
    order_price_amount

    Purchase amount
    vat

    VAT
    subtotal

    Subtotal
    order_status

    Order status

    Awaiting payment: unpaid
    Non delivered: unshipped
    In transit: shipping
    Awaiting shipment: standby
    Delivered: shipped
    Partially canceled: partially_canceled
    Canceled: canceled
    status

    status

    Requested: request
    Awaiting issuance: await_issuance
    Issued: issued
    Issuance rejected: issuance_rejected
    Request canceled: canceled_request
    Issuance canceled: canceled_issuance
    Issuance failed: failed_issuance
    type

    Issuance type

    Individual: personal
    Business: business
    company_registration_no

    Company registration number
    cellphone

    Mobile
    tax_amount

    Tax amount
    tax_free_amount

    Deductions
    supply_price

    Total cost

    List all cashreceipt

    GET

    This API can only be used in stores using Korean.

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    start_date
    Required

    Date
    timezone

    Search Start Date

    end_date
    Required

    Date
    timezone

    Search End Date

    order_id

    Order ID

    Order ID

    approval_no

    Max Length : [9]

    Approval Number

    name

    Max Length : [20]

    Requester

    member_id

    Max Length : [20]

    Member id

    status

    status

    All: all
    Requested: request
    Issued: issued
    Request canceled: canceled_request
    Issuance canceled: canceled_issuance
    Issuance failed: failed_issuance

    DEFAULT all

    limit

    Min : [1]~Max : [500]

    Limit

    DEFAULT 10

    offset

    Max : [8000]

    Start location of list

    Definition Copy
    Request example: Copy
    Response example:

    Create a cashreceipt

    POST

    This API can only be used in stores using Korean.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    order_id
    Required

    Order ID

    Order ID

    type
    Required

    Issuance type

    Individual: personal
    Business: business

    company_registration_no

    Business Number
    Max Length : [10]

    Company registration number

    cellphone

    Mobile
    Max Length : [11]

    Mobile

    Definition Copy
    Request example: Copy
    Response example:

    Update a cashreceipt

    PUT

    This API can only be used in stores using Korean.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    cashreceipt_no
    Required

    Min : [1]

    Cash receipt number

    order_id
    Required

    Order ID

    Order ID

    type

    Issuance type

    Individual: personal
    Business: business

    company_registration_no

    Business Number
    Max Length : [10]

    Company registration number

    cellphone

    Mobile
    Max Length : [11]

    Mobile

    Definition Copy
    Request example: Copy
    Response example:

    Cashreceipt cancellation

    Endpoints 
    PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

    Cashreceipt cancellation properties

    Attribute Description
    cashreceipt_no

    Cash receipt number
    order_id

    Order ID
    status

    status

    Request canceled: canceled_request
    Issuance canceled: canceled_issuance

    Update a cashreceipt cancellation

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    cashreceipt_no
    Required

    Min : [1]

    Cash receipt number

    order_id
    Required

    Order ID

    Order ID

    type
    Required

    Cancellation type

    Cancel request: request
    Cancel issuance: issue

    Definition Copy
    Request example: Copy
    Response example:

    Collectrequests

    Endpoints 
    PUT /api/v2/admin/collectrequests/{request_no}

    Collectrequests properties

    Attribute Description
    shop_no

    Shop Number
    request_no

    Request number
    order_id

    Order ID
    order_item_code

    Order item code
    shipping_company_name

    Collection shipping company name
    collect_tracking_no

    Collection tracking number

    Update a collectrequest

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 30
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    request_no
    Required

    Request number

    collect_tracking_no
    Required

    Max Length : [30]

    Collection tracking number

    Definition Copy
    Request example: Copy
    Response example:

    Exchange

    Endpoints 
    GET /api/v2/admin/exchange/{claim_code}

    Exchange properties

    Attribute Description
    shop_no

    Shop Number

    It can be displayed only in detail inquiry.
    order_id

    Order ID

    It can be displayed only in detail inquiry.
    claim_code

    Exchange number

    It can be displayed only in detail inquiry.
    claim_reason_type

    division

    It can be displayed only in detail inquiry.

    A: change of mind
    B: shipping delay
    J: shipping error
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    K: defective product
    G: dissatisfied with service
    H: out of stock
    I: others
    claim_reason

    Reason

    It can be displayed only in detail inquiry.
    claim_due_date

    Estimated exchange date

    It can be displayed only in detail inquiry.
    receiver

    Receiver

    It can be displayed only in detail inquiry.
    reshipping_detail

    reshipping details

    It can be displayed only in detail inquiry.
    pickup

    Pickup - Address

    It can be displayed only in detail inquiry.
    additional_payment

    Additional payment

    It can be displayed only in detail inquiry.
    return_invoice_no

    return tracking number

    It can be displayed only in detail inquiry.
    return_shipping_company_name

    return shipping carrier

    It can be displayed only in detail inquiry.
    refund_method

    Refund method

    It can be displayed only in detail inquiry.
    refund_reason

    Remarks

    It can be displayed only in detail inquiry.
    order_price_amount

    Purchase amount

    It can be displayed only in detail inquiry.
    refund_amount

    refund amount

    It can be displayed only in detail inquiry.
    shipping_fee

    shipping fee

    It can be displayed only in detail inquiry.
    return_ship_type

    Return shipping cost classification

    It can be displayed only in detail inquiry.
    defer_commission

    Postpayment Fee

    It can be displayed only in detail inquiry.
    partner_discount_amount

    Affiliate discount cancellation amount

    It can be displayed only in detail inquiry.
    add_discount_amount

    Extra discount discount by product

    It can be displayed only in detail inquiry.
    member_grade_discount_amount

    Membership Discount Discount Amount

    It can be displayed only in detail inquiry.
    shipping_discount_amount

    Shipping discount cancellation amount

    It can be displayed only in detail inquiry.
    coupon_discount_amount

    Coupon discount cancellation amount

    It can be displayed only in detail inquiry.
    point_used

    Reimbursement Return Used

    It can be displayed only in detail inquiry.
    credit_used

    Deposit Refund Used

    It can be displayed only in detail inquiry.
    items

    Item Resource

    It can be displayed only in detail inquiry.
    exchanged_items

    Exchanged items

    It can be displayed only in detail inquiry.

    Get an exchange

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    claim_code
    Required

    Exchange number

    Definition Copy
    Request example: Copy
    Response example:

    Orders

    Orders Resource

    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 order has the following Resource as embedded Resource.
    ● Items
    ● Recipient Information

    Endpoints 
    GET /api/v2/admin/orders
GET /api/v2/admin/orders/count
GET /api/v2/admin/orders/{order_id}
PUT /api/v2/admin/orders/{order_id}
PUT /api/v2/admin/orders

    Orders properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    currency

    Currency

    Currecy unit of a mall.
    order_id

    Order ID
    market_id

    Market id

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

    marketplace other information

    Other information of market or order path.
    member_id

    Member id
    member_email

    customer email
    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
    bank_code_name

    Bank name
    payment_method

    payment method code

    Code of payment method that orderer used for payment.

    cash : deposit without a bankbook
    card : credit card
    cell : mobile
    tcash : bank transfer
    icash : virtual account
    prepaid : digital wallet balance
    credit : credits
    point : points
    pointfy : transferable points
    cvs : convenience store
    cod : COD
    coupon : coupon
    market_discount : market discount
    etc : others
    payment_method_name

    Payment method name

    Name of payment method that orderer used for payment.
    payment_gateway_name

    Payment gateway name

    Name of payment gateway that orderer used for payment.
    sub_payment_method_name

    International payment method name
    sub_payment_method_code

    International payment method code

    sub_payment_method_code
    paid

    Paid

    Whether or not the order was paid for

    T: Paid
    F: Unpaid
    M: Partially paid
    order_date

    timezone

    Ordered date
    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
    order_from_mobile

    Mobile type

    whether order made on mobile

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

    Whether to use Escrow

    whether customer used escrow or not

    T: Used escrow
    F: Do not used escrow
    group_no_when_ordering

    Customer group number when ordering
    initial_order_amount

    initial payment details
    actual_order_amount

    final payment details
    bank_account_no

    Bank account no

    Bank account number of shooping mall of the specific order.
    bank_account_owner_name

    Bank account holder number
    market_seller_id

    market vendor ID
    payment_amount

    order total
    cancel_date

    timezone

    Order cancellation date
    order_place_name

    Order path text
    order_place_id

    Available order path
    payment_confirmation

    Whether payment is confirmed

    T: confirmed payment
    F: payment does not confirmed
    commission

    Transaction fee
    postpay

    Whether postpaid

    T: Payment after delivery
    F: No payment after delivery
    admin_additional_amount

    manually input amount
    additional_shipping_fee

    Additional shipping fee
    international_shipping_insurance

    International shipping insurance
    additional_handling_fee

    Additional handling fee
    shipping_type

    Delivery type

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

    A: Domestic
    B: Overseas
    shipping_type_text

    Delivery type

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

    Delivery status

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

    Desired delivery date
    wished_delivery_time

    Desired delivery time
    wished_carrier_id

    Desired courier code
    wished_carrier_name

    name of preferred shipping carrier
    return_confirmed_date

    timezone

    Return approval time
    total_supply_price

    Total supply price
    naver_point

    NAVER points
    additional_order_info_list

    Additional order info
    store_pickup

    Store pickup

    T: Store pickup
    F: No store pickup
    easypay_name

    Easypay payment gateway name
    loan_status

    Loan status

    OK : GOOD
    NG : NOT GOOD
    ER : ERROR
    subscription

    subscription billing in use

    T: subscription billing in use
    F: subscription billing not in use
    items

    Item Resource


    Can search with using embed parameter.
    receivers

    Receiver Resource


    Can search with using embed parameter.
    buyer

    Orderer Resource


    Can search with using embed parameter.
    shipping_fee_detail

    Shipping fee information
    regional_surcharge_detail

    Regional surcharge details
    return

    Return Details Resource


    Can search with using embed parameter.
    cancellation

    Cancellation details Resource


    Can search with using embed parameter.
    exchange

    Exchange details Resource


    Can search with using embed parameter.
    multiple_addresses

    Multi-address order

    T: Yes (Multi-address order)
    F: No (Single-address order)
    exchange_rate

    Exchange rate
    first_payment_method

    initial payment method code

    cash : deposit without a bankbook
    card : credit card
    cell : mobile
    tcash : bank transfer
    icash : virtual account
    prepaid : digital wallet balance
    credit : credits
    point : points
    pointfy : transferable points
    cvs : convenience store
    cod : COD
    etc : others
    naverpay_payment_information

    NaverPay PG payment information

    P: PG payment
    N: NaverPay
    customer_group_no_when_ordering

    Customer group number when ordering

    Customer group number when order occurred.

    It can be displayed only in detail inquiry.
    benefits

    Benefits Resource


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.
    coupons

    Coupon Resource


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.
    refunds

    refund details resource


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.
    process_status

    Order status

    prepare: preparing for shipment
    prepareproduct: order in progress
    hold: shipment on hold
    unhold: removed from held off shipments
    order_item_code

    Order item code

    List all orders

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    items
    embed

    Item Resource


    Can search with using embed parameter.

    receivers
    embed

    Receiver Resource


    Can search with using embed parameter.

    buyer
    embed

    Orderer Resource


    Can search with using embed parameter.

    return
    embed

    Return Details Resource


    Can search with using embed parameter.

    cancellation
    embed

    Cancellation details Resource


    Can search with using embed parameter.

    exchange
    embed

    Exchange details Resource


    Can search with using embed parameter.

    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    Search Start Date

    start date for search

    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

    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: awaiting payment
    N10: order in progress
    N20: preparing for shipment
    N21: awaiting shipment
    N22: shipment on hold
    N30: in transit
    N40: delivered
    C00: cancellation requested
    C10: cancellation accepted - admin
    C34: cancellation in progress – awaiting refund
    C36: cancellation in progress – refund on hold
    C40: canceled
    C47: canceled before payment - customer
    C48: canceled before payment – auto-canceled
    C49: canceled before payment - admin
    R00: return requested
    R10: return accepted
    R12: return on hold
    R30: return in progress – awaiting pickup
    R34: return in progress – awaiting refund
    R36: return in progress - refund on hold
    R40: returned - refunded
    E00: exchange requested
    E10: exchange accepted
    E12: exchange on hold
    E20: exchange postponed
    E30: exchange in progress - awaiting pickup
    E32: exchange in progress - awaiting payment
    E34: exchange in progress – awaiting refund
    E36: exchange in progress – refund on hold
    E40: exchanged

    member_type

    Member type

    Whether member or not. Each has its own code.

    2: Member
    3: Nonmember

    group_no

    Group number

    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.

    name_furigana

    Receiver name (Pronunciation)

    receiver_address

    Receiver address

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

    member_id

    Member id

    member id

    member_email

    customer email

    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: order date
    pay_date: payment date
    shipbegin_date: shipping date
    shipend_date: delivery date
    cancel_date: date order canceled
    place_date: date of order
    updatereceiver_date: date shipping information updated
    cancel_complete_date: date cancellation completed
    exchange_request_date: date exchange requested
    exchange_accept_date: date exchange accepted
    exchange_complete_date: date exchange completed
    return_request_date: date return requested
    return_accept_date: date return accepted
    return_complete_date: date return completed

    DEFAULT order_date

    supplier_id

    Supplier id

    You can search multiple item with ,(comma)

    order_place_id

    Available order path

    You can search multiple item with ,(comma)

    cafe24:Cafe24
    mobile:mobile web
    mobile_d:mobile app
    NCHECKOUT:NAVER Pay
    inpark:Interpark
    auction:Auction
    sk11st:11th Street
    gmarket:Gmarket
    coupang:Coupang
    shopn:Smart store

    buyer_cellphone

    Buyer mobile number

    buyer_phone

    Buyer phone number

    buyer_email

    Buyer Email

    inflow_path

    sales funnel

    subscription

    subscription billing in use

    T: subscription billing in use
    F: subscription billing not in use

    market_cancel_request

    marketplace order cancellation

    T: cancellation requested marketplace order

    payment_method

    payment method code

    You can search multiple item with ,(comma)

    cash : deposit without a bankbook
    card : credit card
    tcash : bank transfer
    cell : mobile
    deferpay : COD
    cvs : convenience store
    point : digital wallet balance
    mileage : points
    deposit : credits
    etc : others

    payment_gateway_name

    Payment gateway name

    You can search multiple item with ,(comma)

    market_seller_id

    market vendor ID

    limit

    Min : [1]~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

    Definition Copy
    Request example: Copy
    Response example:

    Count all orders

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    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 searching orders. Must be used with a search start date.

    order_id

    Order ID

    Order ID

    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: awaiting payment
    N10: order in progress
    N20: preparing for shipment
    N21: awaiting shipment
    N22: shipment on hold
    N30: in transit
    N40: delivered
    C00: cancellation requested
    C10: cancellation accepted - admin
    C34: cancellation in progress – awaiting refund
    C36: cancellation in progress – refund on hold
    C40: canceled
    C47: canceled before payment - customer
    C48: canceled before payment – auto-canceled
    C49: canceled before payment - admin
    R00: return requested
    R10: return accepted
    R12: return on hold
    R30: return in progress – awaiting pickup
    R34: return in progress – awaiting refund
    R36: return in progress - refund on hold
    R40: returned - refunded
    E00: exchange requested
    E10: exchange accepted
    E12: exchange on hold
    E20: exchange postponed
    E30: exchange in progress - awaiting pickup
    E32: exchange in progress - awaiting payment
    E34: exchange in progress – awaiting refund
    E36: exchange in progress – refund on hold
    E40: exchanged

    member_type

    Member type

    Customer settings. Different codes are assigned to customers and guests.

    2: Member
    3: Nonmember

    group_no

    Group number

    buyer_name

    Buyer name

    Name of customer who orders the product. It may be different from the name of the depositor or the recipient.

    receiver_name

    Receiver name

    Name of the recipient. May differ from the address of the customer or the depositor

    name_furigana

    Receiver name (Pronunciation)

    receiver_address

    Receiver address

    Address of the recipient. May differ from the address of the customer or the depositor

    member_id

    Member id

    Customer ID

    member_email

    customer email

    product_no

    Product number

    Product number

    product_code

    Product code

    Search for products of which product codes include the search query that you enter. The search query is case-insensitive.

    date_type

    Date type

    Date filter type for search. The default value is date of order.

    order_date: order date
    pay_date: payment date
    shipbegin_date: shipping date
    shipend_date: delivery date
    cancel_date: date order canceled
    place_date: date of order
    updatereceiver_date: date shipping information updated
    cancel_complete_date: date cancellation completed
    exchange_request_date: date exchange requested
    exchange_accept_date: date exchange accepted
    exchange_complete_date: date exchange completed
    return_request_date: date return requested
    return_accept_date: date return accepted
    return_complete_date: date return completed

    DEFAULT order_date

    supplier_id

    Supplier id

    You can search multiple item with ,(comma)

    order_place_id

    Available order path

    You can search multiple item with ,(comma)

    cafe24:Cafe24
    mobile:mobile web
    mobile_d:mobile app
    NCHECKOUT:NAVER Pay
    inpark:Interpark
    auction:Auction
    sk11st:11th Street
    gmarket:Gmarket
    coupang:Coupang
    shopn:Smart store

    buyer_cellphone

    Buyer mobile number

    buyer_phone

    Buyer phone number

    buyer_email

    Buyer Email

    inflow_path

    sales funnel

    subscription

    subscription billing in use

    T: subscription billing in use
    F: subscription billing not in use

    market_cancel_request

    marketplace order cancellation

    T: cancellation requested marketplace order

    payment_method

    payment method code

    You can search multiple item with ,(comma)

    cash : deposit without a bankbook
    card : credit card
    tcash : bank transfer
    cell : mobile
    deferpay : COD
    cvs : convenience store
    point : digital wallet balance
    mileage : points
    deposit : credits
    etc : others

    payment_gateway_name

    Payment gateway name

    You can search multiple item with ,(comma)

    market_seller_id

    market vendor ID

    Definition Copy
    Request example: Copy
    Response example:

    Get an order

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    items
    embed

    Item Resource


    Can search with using embed parameter.

    receivers
    embed

    Receiver Resource


    Can search with using embed parameter.

    buyer
    embed

    Orderer Resource


    Can search with using embed parameter.

    benefits
    embed

    Benefits Resource


    Can search with using embed parameter.

    coupons
    embed

    Coupon Resource


    Can search with using embed parameter.

    return
    embed

    Return Details Resource


    Can search with using embed parameter.

    cancellation
    embed

    Cancellation details Resource


    Can search with using embed parameter.

    exchange
    embed

    Exchange details Resource


    Can search with using embed parameter.

    refunds
    embed

    refund details resource


    Can search with using embed parameter.

    Definition Copy
    Request example: Copy
    Response example:

    Update an order

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    process_status
    Required

    Order status

    prepare: preparing for shipment
    prepareproduct: order in progress
    hold: shipment on hold
    unhold: removed from held off shipments

    order_item_code

    Order item code

    Definition Copy
    Request example: Copy
    Response example:

    Update orders

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 100

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    process_status
    Required

    Order status

    prepare: preparing for shipment
    prepareproduct: order in progress
    hold: shipment on hold
    unhold: removed from held off shipments

    order_item_code

    Order item code

    Definition Copy
    Request example: Copy
    Response example:

    Orders autocalculation

    Endpoints 
    DELETE /api/v2/admin/orders/{order_id}/autocalculation

    Orders autocalculation properties

    Attribute Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1
    order_id

    Order ID

    Delete an orders autocalculation

    DELETE

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    Definition Copy
    Request example: Copy
    Response example:

    Orders buyer

    A resource about a customer’s name, contact information, and address. You can only use this resource as a child resource of the Order resource.

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/buyer
PUT /api/v2/admin/orders/{order_id}/buyer

    Orders buyer properties

    Attribute Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages
    member_id

    Member id
    member_group_no

    customer group number when ordered

    Customer group number.
    name

    Buyer name

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

    orderer name in Japanese Furigana
    email

    Buyer Email

    email of the customer
    phone

    Buyer phone number

    Phone number of a buyer.
    cellphone

    Buyer mobile number

    Cellphone number of a buyer.
    customer_notification

    customer notification

    Note for customer to know.
    updated_date

    timezone

    Updated date
    user_id

    ID of the persons modified the orderer

    Id of a person who updated buyer information.
    user_name

    name of the persons modified the order

    Nmae of a person who updated buyer information.
    order_id

    Order ID

    Order ID

    order number

    Get an orders buyer

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    order number

    Definition Copy
    Request example: Copy
    Response example:

    Update an orders buyer

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    order number

    name

    Buyer name

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

    email

    Email

    Buyer Email

    email of the customer

    phone

    Buyer phone number

    Phone number of a buyer.

    cellphone

    Buyer mobile number

    Cellphone number of a buyer.

    customer_notification

    customer notification

    Note for customer to know.

    Definition Copy
    Request example: Copy
    Response example:

    Orders buyer history

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/buyer/history

    Orders buyer history properties

    Attribute Description
    shop_no

    Min : [1]

    Shop Number
    name

    Buyer name
    email

    Email

    Buyer Email
    phone

    Buyer phone number
    cellphone

    Buyer mobile number
    customer_notification

    customer notification
    updated_date

    timezone

    Updated date
    user_id

    ID of the persons modified the orderer
    user_name

    name of the persons modified the order

    List all orders buyer history

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    Definition Copy
    Request example: Copy
    Response example:

    Orders cancellation

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/cancellation

    Orders cancellation properties

    Attribute Description
    shop_no

    Min : [1]

    Shop Number
    order_id

    Order ID
    status

    Order status

    canceled : canceled
    claim_code

    cancellation number
    items

    Order item code

    Create an orders cancellation

    POST

    This API allows you to process cancellations for a specific order. When cancellations are processed by using this API, orders will be marked as canceled and payments will be canceled via payment gateways. (When "T" is used for "payment_gateway_cancel")

    For partial cancellations, refund amount for each order will be automatically calculated and processed.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    payment_gateway_cancel

    PG cancellation request settings

    Cancellations cannot be processed via payment gateways when multiple payment methods have been used. Cancellations must be processed through Cafe24 admin system.
    Unavailable for marketplace or NAVER Pay order cancellations

    T : cancel
    F : do not cancel

    DEFAULT F

    status
    Required

    Order status

    canceled : canceled

    recover_inventory

    Inventory Recovery

    T : Recover
    F : Do not recover

    DEFAULT F

    recover_coupon

    restore a coupon

    Unavailable for marketplace or NAVER Pay order cancellations

    T : Recover
    F : Do not recover

    DEFAULT F

    add_memo_too

    add to admin memo

    Unavailable for marketplace or NAVER Pay order cancellations

    T: Enable
    F: Disable

    DEFAULT F

    reason

    Max Length : [2000]

    reason for cancellation

    claim_reason_type

    type of reason for cancellation

    Unavailable for marketplace or NAVER Pay order cancellations

    A: change of mind
    B: shipping delay
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    G: dissatisfied with service
    H: out of stock
    I: others

    naverpay_cancel_reason_type

    reason for NAVER Pay order cancellation

    Unavailable for Cafe24 store or marketplace order cancellations

    This cannot be used on Cafe24 Vietnam, Philippines.

    51 : change of mind
    52 : change color or size
    53 : bought by mistake
    54 : dissatisfied with service or product
    55 : delay in shipping
    56 : out of stock
    60 : different from product details

    refund_method_code

    Refund method

    T : cash
    F : credit card
    M : points
    G : bank transfer
    C : mobile
    D : credits
    Z : COD
    O : digital wallet balance
    V : convenience store
    I : others

    combined_refund_method

    Mixed refund methods

    When credit card, bank transfer or mobile payment is selected as refund method (refund_method_code), another payment method that will be used to receive refunds for an order paid with multiple payment methods can be selected. (Only "F" can be used for "payment_gateway".)

    Note that when the refund amount is smaller than the amount paid via payment gateway, total refund will be processed via the main payment method.

    T : cash
    M : points
    D : credits

    refund_bank_code

    code assigned to bank for refunds

    Required when refund method (refund_method) is set as cash (T)

    refund_bank_code

    Required for Korean stores
    Available only when refund method (refund_method) is set as cash (T)
    Unavailable for marketplace or NAVER Pay order cancellations

    refund_bank_name

    Max Length : [250]

    Bank name

    Required when refund method (refund_method) is set as cash (T)

    Required for international stores

    Available only when refund method (refund_method) is set as cash (T)
    Unavailable for marketplace or NAVER Pay order cancellations

    refund_bank_account_no

    Max Length : [50]

    Refund account number

    Required when refund method (refund_method) is set as cash (T)
    Unavailable for marketplace or NAVER Pay order cancellations

    refund_bank_account_holder

    Max Length : [15]

    Refund Account Account Holder's Name

    items

    Order item code

    order_item_code
    Order item code
    Required

    quantity
    Available inventory
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Orders inflowgroups

    Endpoints 
    GET /api/v2/admin/orders/inflowgroups
POST /api/v2/admin/orders/inflowgroups
PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}
DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

    Orders inflowgroups properties

    Attribute Description
    inflow_group_id

    traffic source ID
    inflow_group_name

    traffic source name

    List all orders inflowgroups

    GET

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40
    Definition Copy
    Request example: Copy
    Response example:

    Create an orders inflowgroup

    POST

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    inflow_group_id
    Required

    Max Length : [40]
    Type : [a-zA-Z0-9]

    traffic source ID

    inflow_group_name
    Required

    Max Length : [100]

    traffic source name

    Definition Copy
    Request example: Copy
    Response example:

    Update an orders inflowgroup

    PUT

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    inflow_group_id
    Required

    Type : [a-zA-Z0-9]
    Max Length : [40]

    traffic source ID

    inflow_group_name
    Required

    Max Length : [100]

    traffic source name

    Definition Copy
    Request example: Copy
    Response example:

    Delete an orders inflowgroup

    DELETE

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40

    Request

    Parameter Description
    inflow_group_id
    Required

    Max Length : [40]
    Type : [a-zA-Z0-9]

    traffic source ID

    Definition Copy
    Request example: Copy
    Response example:

    Orders inflowgroups inflows

    Endpoints 
    GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows
POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows
PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}
DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

    Orders inflowgroups inflows properties

    Attribute Description
    inflow_id

    traffic source medium ID
    inflow_name

    traffic source medium name
    inflow_icon

    funnel icon
    group_id

    traffic source ID

    List all orders inflowgroups inflows

    GET

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    group_id
    Required

    Max Length : [40]

    traffic source ID

    Definition Copy
    Request example: Copy
    Response example:

    Create an orders inflowgroups inflow

    POST

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    group_id
    Required

    Max Length : [40]

    traffic source ID

    inflow_id
    Required

    Max Length : [40]

    traffic source medium ID

    inflow_name
    Required

    Max Length : [100]

    traffic source medium name

    inflow_icon
    Required

    URL
    Max Length : [500]

    funnel icon

    Definition Copy
    Request example: Copy
    Response example:

    Update an orders inflowgroups inflow

    PUT

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    group_id
    Required

    Max Length : [40]

    traffic source ID

    inflow_id
    Required

    Max Length : [40]

    traffic source medium ID

    inflow_name
    Required

    Max Length : [100]

    traffic source medium name

    inflow_icon
    Required

    URL
    Max Length : [500]

    funnel icon

    Definition Copy
    Request example: Copy
    Response example:

    Delete an orders inflowgroups inflow

    DELETE

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40

    Request

    Parameter Description
    group_id
    Required

    Max Length : [40]

    traffic source ID

    inflow_id
    Required

    Max Length : [40]

    traffic source medium ID

    Definition Copy
    Request example: Copy
    Response example:

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

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/items
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

    Orders items properties

    Attribute Description
    shop_no

    Shop Number
    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.
    custom_product_code

    Max Length : [40]

    Custom product code
    custom_variant_code

    Custom variants code
    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
    additional_option_value

    Additional option value
    additional_option_values

    custom text list
    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_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.
    coupon_discount_price

    discount price for product-specific coupon
    app_item_discount_amount

    product discount price for app
    actual_payment_amount

    Amount paid per item
    quantity

    Available inventory

    Quantity of ordered product.
    product_tax_type

    Tax classify by products

    A: Taxable
    B: Tax-free C: Nontaxable
    tax_amount

    Tax rate
    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
    shipping_code

    Shipping code

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

    Cancellation/Exchange/Return Number
    claim_reason_type

    type of cancellation/exchange/return request reason

    Type of reason for cancellation/exchange/refund request submitted by a customer
    Reason for accepting cancellation/exchange/refund request by admin can be retrieved by using "claim_reason_type" under "cancellations/exchanges/refunds" resource.
    claim_reason

    reason for cancellation/exchange/return request

    Detailed reason for cancellation/exchange/refund request submitted by a customer
    Reason for accepting cancellation/exchange/refund request by admin can be retrieved by using "claim_reason_type" under "cancellations/exchanges/refunds" resource.
    refund_bank_name

    Bank name
    refund_bank_account_no

    Refund account number
    refund_bank_account_holder

    Refund Account Account Holder's Name
    post_express_flag

    Post express flag

    Whether post express linked or not.
    order_status

    Order status

    Order status. Each status has its own code.
    request_undone

    undone request type

    Cancellation: cancellation undone
    Exchange: exchange undone
    Return: return undone
    order_status_additional_info

    Order status additional info

    order status additional info
    claim_quantity

    number of cancellation/exchange/return requests
    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
    bundled_shipping_type

    combined shipment type

    Bundel shipping type of the order.

    N: General delivery for a single order (Normal)
    C: Combined delivery for a combination order (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 carrier code

    shipping_company_code
    product_bundle

    Product bundle

    T: Set product
    F: No set product
    product_bundle_no

    Set product number

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

    Set product name

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

    Set product 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
    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: Pay 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.
    shipping_payment_option

    digital wallet balance/Pay after delivery

    C: Pay after delivery
    P: digital wallet balance
    F: free
    payment_info_id

    Payment information ID
    original_item_no

    Original item no
    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
    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_confirmed_date

    timezone

    Return approval time
    return_request_date

    timezone

    Return request date

    Date of return requested.
    return_collected_date

    timezone

    return pickup date
    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.
    clearance_category_code
    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)
    origin_place_no

    Code of origin
    made_in_code

    Origin country code
    gift

    Gift

    Whether product is for gift or not.

    T: gift
    F: not a gift
    item_granting_gift

    Items that need to be purchased to offer gifts
    subscription

    subscription billing in use

    T: subscription billing in use
    F: subscription billing not in use
    product_bundle_list

    List of set items
    market_cancel_request

    marketplace order cancellation

    T: marketplace order with cancellation request submitted
    F: marketplace order with no cancellation request submitted
    market_cancel_request_quantity

    number of cancellation requested marketplace order
    market_fail_reason

    reason for marketplace order failure
    market_fail_reason_guide

    detailed reason for marketplace order failure
    market_custom_variant_code

    online marketplace custom variant code
    order_id

    Order ID
    claim_type

    cancellation/exchange/return type
    claim_status

    cancellation/exchange/return request status

    List all orders items

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    Definition Copy
    Request example: Copy
    Response example:

    Update an orders item

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    order_item_code
    Required

    Order item code

    claim_type
    Required

    cancellation/exchange/return type

    C: cancel
    R: return

    claim_status
    Required

    cancellation/exchange/return request status

    T : submit request
    F : do not submit request

    claim_reason_type
    Required

    type of cancellation/exchange/return request reason

    A: change of mind
    B: shipping delay
    J: shipping error
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    K: defective product
    G: dissatisfied with service
    H: out of stock
    I: others

    claim_reason

    reason for cancellation/exchange/return request

    claim_quantity

    number of cancellation/exchange/return requests

    Definition Copy
    Request example: Copy
    Response example:

    Orders memos

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/memos
POST /api/v2/admin/orders/{order_id}/memos
PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}
DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

    Orders memos properties

    Attribute Description
    shop_no

    Shop Number
    memo_no

    Memo number
    created_date

    timezone

    memo added date
    author_id

    Author ID
    ip

    author IP address
    use_customer_inquiry

    added to customer inquiries

    T: Used
    F: Not used
    attach_type

    attached to

    O : order number
    P : item code
    content

    Memo description
    starred_memo

    Important memo

    T: Important memo
    F: General memo
    fixed

    pinned to top

    T: Used
    F: Not used
    product_list

    Product list
    topic_type

    inquiry type

    cs_01 : shipping
    cs_02 : product
    cs_03 : payment
    cs_04 : order cancellation
    cs_05 : change in product to order
    status

    response status

    F : in progress
    T : resolved

    List all orders memos

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    Definition Copy
    Request example: Copy
    Response example:

    Create an orders memo

    POST

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    content
    Required

    Max Length : [1000]

    Memo description

    use_customer_inquiry

    added to customer inquiries

    T: Used
    F: Not used

    DEFAULT F

    topic_type

    inquiry type

    cs_01 : shipping
    cs_02 : product
    cs_03 : payment
    cs_04 : order cancellation
    cs_05 : change in product to order

    status

    response status

    F : in progress
    T : resolved

    attach_type

    attached to

    O : order number
    P : item code

    DEFAULT O

    starred_memo

    Important memo

    T: Important memo
    F: General memo

    DEFAULT F

    fixed

    pinned to top

    T: Used
    F: Not used

    DEFAULT F

    product_list

    Product list

    Definition Copy
    Request example: Copy
    Response example:

    Update an orders memo

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    memo_no
    Required

    Memo number

    content

    Max Length : [1000]

    Memo description

    use_customer_inquiry

    added to customer inquiries

    T: Used
    F: Not used

    DEFAULT F

    topic_type

    inquiry type

    cs_01 : shipping
    cs_02 : product
    cs_03 : payment
    cs_04 : order cancellation
    cs_05 : change in product to order

    status

    response status

    F : in progress
    T : resolved

    attach_type

    attached to

    O : order number
    P : item code

    DEFAULT O

    starred_memo

    Important memo

    T: Important memo
    F: General memo

    DEFAULT F

    fixed

    pinned to top

    T: Used
    F: Not used

    DEFAULT F

    product_list

    Product list

    Definition Copy
    Request example: Copy
    Response example:

    Delete an orders memo

    DELETE

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    memo_no
    Required

    Memo number

    Definition Copy
    Request example: Copy
    Response example:

    Orders payments

    Endpoints 
    PUT /api/v2/admin/orders/{order_id}/payments

    Orders payments properties

    Attribute Description
    shop_no

    Shop Number
    order_id

    Order ID
    change_payment_amount

    change in payment amount

    T: Use
    F: Do not use
    change_payment_method

    change in payment method

    T: Use
    F: Do not use
    payment_method

    Payment Method
    payment_gateway_failure_message

    error message displayed for PG transaction cancellations
    admin_additional_amount

    manually input amount
    commission

    Transaction fee
    initial_estimated_payment_amount

    initial estimated payment amount
    change_payment_amount_reason

    reason for change in payment amount

    Update an orders payment

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    change_payment_amount
    Required

    change in payment amount

    T: Use
    F: Do not use

    change_payment_method
    Required

    change in payment method

    T: Use
    F: Do not use

    payment_method

    Payment Method

    cash: Bank transfer
    daibiki : Daibiki (COD)

    billing_name

    Max Length : [40]

    Depositor name

    Available when "change_payment_method" is set as "T", and the payment method is changed to bank deposit.

    bank_account_id

    bank ID (for bank transfer without a bankbook)

    Available when "change_payment_method" is set as "T", and the payment method is changed to bank deposit.

    admin_additional_amount

    Min : [0]
    Max : [10000000]

    manually input amount

    Available when "change_payment_amount" is set as "T".

    commission

    Min : [0]
    Max : [10000000]

    Transaction fee

    Available when "change_payment_amount" is set as "T", and the payment method is changed to Daibiki.

    change_payment_amount_reason

    Max Length : [255]

    reason for change in payment amount

    Available when "change_payment_amount" is set as "T".

    Definition Copy
    Request example: Copy
    Response example:

    Orders paymenttimeline

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/paymenttimeline
GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

    Orders paymenttimeline properties

    Attribute Description
    shop_no

    Shop Number
    payment_no

    Payment number
    payment_settle_type

    payment type

    O: initial payment
    R: additional payment
    P: refund
    order_amount

    Order Amount
    additional_payment_amount

    alternative payment amount
    paid_amount

    amount paid
    payment_methods

    Payment Method
    payment_datetime

    timezone

    Payment date
    created_datetime

    timezone

    input date
    payment_method_detail

    payment amounts by payment method

    payment_method_detail code

    It can be displayed only in detail inquiry.
    order_amount_detail

    price and fee details

    order_amount_detail code

    It can be displayed only in detail inquiry.

    List all orders paymenttimeline

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Definition Copy
    Request example: Copy
    Response example:

    Get an orders paymenttimeline

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    payment_no
    Required

    Min : [1]

    Payment number

    Definition Copy
    Request example: Copy
    Response example:

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

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

    Orders receivers properties

    Attribute Description
    shop_no

    Min : [1]

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1
    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
    address_state

    state
    address_city

    City / Town
    address_street

    street
    address_full

    Full address
    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_name

    Country
    country_name_en

    Country (English)
    shipping_message

    Shipping message
    clearance_information_type

    customs clearance information

    I: ID
    P: Passport number
    C: Personal Customs Clearance Code
    clearance_information

    customs clearance information
    wished_delivery_date

    Desired delivery date
    wished_delivery_time

    Desired delivery time
    shipping_code

    Shipping code
    change_default_shipping_address

    Change default shipping address

    T: Yes
    F: No

    List all orders receivers

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    A unique number assigned to a store using the default store language or other languages

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    shipping_code

    Shipping code

    You can search multiple item with ,(comma)

    Definition Copy
    Request example: Copy
    Response example:

    Update orders receivers

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 100

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    name

    Max Length : [20]

    Receiver name

    phone

    Max Length : [20]

    Receiver phone number

    cellphone

    Max Length : [20]

    Receiver mobile phone number

    shipping_message

    Shipping message

    name_furigana

    Receiver name (Pronunciation)

    zipcode

    Min Length : [2]
    Max Length : [14]

    Zipcode

    address1

    Max Length : [255]

    Address 1

    address2

    Max Length : [255]

    Address 2

    address_state

    state

    address_city

    City / Town

    name_en

    Receiver name (English)

    city_en

    Receiver city (English)

    state_en

    Receiver state (English)

    street_en

    Receiver address (English)

    country_code

    Country code

    clearance_information_type

    customs clearance information

    I: ID
    P: Passport number
    C: Personal Customs Clearance Code

    clearance_information

    customs clearance information

    shipping_code

    Shipping code

    change_default_shipping_address

    Change default shipping address

    T: Yes
    F: No

    DEFAULT F

    virtual_phone_no

    Receiver virtual number

    Definition Copy
    Request example: Copy
    Response example:

    Update an orders receiver

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    shipping_code
    Required

    Shipping code

    name

    Max Length : [20]

    Receiver name

    phone

    Max Length : [20]

    Receiver phone number

    cellphone

    Max Length : [20]

    Receiver mobile phone number

    shipping_message

    Shipping message

    name_furigana

    Receiver name (Pronunciation)

    zipcode

    Min Length : [2]
    Max Length : [14]

    Zipcode

    address1

    Max Length : [255]

    Address 1

    address2

    Max Length : [255]

    Address 2

    address_state

    state

    address_city

    City / Town

    name_en

    Receiver name (English)

    city_en

    Receiver city (English)

    state_en

    Receiver state (English)

    street_en

    Receiver address (English)

    country_code

    Country code

    clearance_information_type

    customs clearance information

    I: ID
    P: Passport number
    C: Personal Customs Clearance Code

    clearance_information

    customs clearance information

    change_default_shipping_address

    Change default shipping address

    T: Yes
    F: No

    DEFAULT F

    virtual_phone_no

    Receiver virtual number

    Definition Copy
    Request example: Copy
    Response example:

    Orders receivers history

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/receivers/history

    Orders receivers history properties

    Attribute Description
    shop_no

    Min : [1]

    Shop Number
    name

    Receiver name
    phone

    Office phone number
    cellphone

    Receiver mobile phone number
    zipcode

    Zipcode
    address1

    Address 1
    address2

    Address 2
    address_state

    state
    address_city

    City / Town
    address_street

    street
    address_full

    Full address
    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_name

    Country
    country_name_en

    Country (English)
    shipping_message

    Shipping message
    updated_date

    timezone

    Updated date
    user_id

    ID of the persons modified the orderer
    user_name

    name of the persons modified the order
    shipping_code

    Shipping code

    List all orders receivers history

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    Definition Copy
    Request example: Copy
    Response example:

    Orders return

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/return

    Orders return properties

    Attribute Description
    shop_no

    Shop Number
    order_id

    Order ID
    status

    Order status

    canceled : canceled
    claim_code

    cancellation number
    items

    Order item code

    Create an orders return

    POST

    This API allows you to process returns for a specific order. When returns are processed by using this API, orders will be marked as returned and payments will be canceled via payment gateways. (When "T" is used for "payment_gateway_cancel")

    For partial cancellations, refund amount for each order will be automatically calculated and processed.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    payment_gateway_cancel

    PG cancellation request settings

    Cancellations cannot be processed via payment gateways when multiple payment methods have been used. Cancellations must be processed through Cafe24 admin system.
    Unavailable for marketplace or NAVER Pay order cancellations

    T : cancel
    F : do not cancel

    DEFAULT F

    status
    Required

    Order status

    returned: returned

    recover_inventory

    Inventory Recovery

    T : Recover
    F : Do not recover

    DEFAULT F

    recover_coupon

    restore a coupon

    T : Recover
    F : Do not recover

    DEFAULT F

    add_memo_too

    add to admin memo

    T: Enable
    F: Disable

    DEFAULT F

    reason

    Max Length : [2000]

    refund reason

    claim_reason_type

    type of refund reason

    A: change of mind
    B: shipping delay
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    G: dissatisfied with service
    H: out of stock
    I: others

    naverpay_return_reason_type

    reason for NAVER Pay order cancellation

    This cannot be used on Cafe24 Vietnam, Philippines, Japan.

    51 : change of mind
    52 : change color or size
    53 : bought by mistake
    54 : dissatisfied with service or product
    55 : delay in shipping
    56 : out of stock
    57 : item missing
    58 : non delivered
    59 : damaged product
    60 : item is different from product details
    61 : shipping error
    62 : delivered wrong item (different product options - e.g.
    wrong color)

    refund_method_code

    Refund method

    T : cash
    F : credit card
    M : points
    G : bank transfer
    C : mobile
    D : credits
    Z : COD
    O : digital wallet balance
    V : convenience store
    I : others

    combined_refund_method

    Mixed refund methods

    When credit card, bank transfer or mobile payment is selected as refund method (refund_method_code), another payment method that will be used to receive refunds for an order paid with multiple payment methods can be selected. (Only "F" can be used for "payment_gateway".)

    Note that when the refund amount is smaller than the amount paid via payment gateway, total refund will be processed via the main payment method.

    T : cash
    M : points
    D : credits

    refund_bank_code

    code assigned to bank for refunds

    Required when refund method (refund_method) is set as cash (T)

    refund_bank_code

    Required for Korean stores
    Available only when refund method (refund_method) is set as cash (T)

    refund_bank_name

    Max Length : [250]

    Bank name

    Required when refund method (refund_method) is set as cash (T)

    Required for international stores

    Available only when refund method (refund_method) is set as cash (T)

    refund_bank_account_no

    Max Length : [50]

    Refund account number

    Required when refund method (refund_method) is set as cash (T)

    refund_bank_account_holder

    Max Length : [15]

    Refund Account Account Holder's Name

    items

    Order item code

    order_item_code
    Order item code
    Required

    quantity
    Available inventory
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Orders shipments

    This resource is about shipping information required for fulfillment. This resource contains information such as invoice number, carrier, shipping status, etc.

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/shipments
POST /api/v2/admin/orders/{order_id}/shipments
PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}
DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

    Orders shipments properties

    Attribute Description
    shop_no

    Shop Number

    DEFAULT 1
    shipping_code

    Shipping code
    order_id

    Order ID
    tracking_no

    Tracking number
    tracking_no_updated_date

    timezone

    Input date (Tracking number)
    shipping_company_code

    shipping carrier code

    shipping_company_code
    items

    list of items
    status

    Order status

    standby : waiting for shipping
    shipping : on delivery
    shipped : delivered
    order_item_code

    Order item code
    status_additional_info

    Order status additional info

    List all orders shipments

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Order ID

    Definition Copy
    Request example: Copy
    Response example:

    Register shipments information

    POST

    You can flag orders to indicate the shipping status such as Awaiting shipment or In-transit.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    tracking_no
    Required

    Max Length : [30]

    Tracking number

    shipping_company_code
    Required

    shipping carrier code

    shipping_company_code

    order_item_code

    Order item code

    status
    Required

    Order status

    standby : waiting for shipping
    shipping : on delivery

    shipping_code

    Shipping code

    Definition Copy
    Request example: Copy
    Response example:

    Update orders shipment information

    PUT

    You can update shipping information (shipping status, etc.).

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    shipping_code
    Required

    Shipping code

    status

    Order status

    "tracking_no" and "shipping_company_code" cannot be used when "status" is used to change the shipping status.

    standby : waiting for shipping
    shipping : on delivery
    shipped : delivered

    status_additional_info

    Max Length : [30]

    Order status additional info

    tracking_no

    Max Length : [30]

    Tracking number

    "shipping_company_code" must be used with "tracking_no", and "status" cannot be used to change the shipping status.

    shipping_company_code

    shipping carrier code

    shipping_company_code

    To use "tracking_no", "shipping_company_code" must be used as well. "status" cannot be used to edit a tracking number.

    Definition Copy
    Request example: Copy
    Response example:

    Delete an orders shipment

    DELETE

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    shipping_code
    Required

    Shipping code

    Definition Copy
    Request example: Copy
    Response example:

    Orders shippingfeecancellation

    Endpoints 
    GET /api/v2/admin/orders/{order_id}/shippingfeecancellation
POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

    Orders shippingfeecancellation properties

    Attribute Description
    shop_no

    Shop Number
    order_id

    Order ID
    default_shipping_fee

    default shipping fee
    supplier_shipping_fee

    Default shipping fee (store)
    individual_shipping_fee

    Individual shipping fee
    international_shipping_fee

    해외배송비
    international_shipping_insurance_fee

    International shipping insurance
    additional_shipping_fee

    Additional shipping fee
    additional_handling_fee

    Additional handling fee
    regional_surcharge_amount

    regional shipping rates
    claim_code

    cancellation number
    claim_reason_type

    division

    A: change of mind
    B: shipping delay
    J: shipping error
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    K: defective product
    G: dissatisfied with service
    H: out of stock
    I: others
    claim_reason

    Reason
    refund_method

    Refund method
    shipping_discount_amount

    Shipping discount cancellation amount
    coupon_discount_amount

    Coupon discount cancellation amount
    refund_amount

    refund amount
    point_used

    Reimbursement Return Used
    credit_used

    Deposit Refund Used
    mixed_refund_amount

    mixed refund amount
    mixed_refund_methods

    Mixed refund methods
    status

    Order status

    LIBSPECDATACANCELING.PROCESSING

    List all orders shippingfeecancellation

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    Definition Copy
    Request example: Copy
    Response example:

    Create an orders shippingfeecancellation

    POST

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    reason

    Max Length : [2000]

    reason for cancellation

    claim_reason_type

    type of reason for cancellation

    A: change of mind
    B: shipping delay
    J: shipping error
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    K: defective product
    G: dissatisfied with service
    H: out of stock
    I: others

    recover_coupon

    restore a coupon

    T : Recover
    F : Do not recover

    DEFAULT F

    refund_method_code

    Refund method

    T : cash
    F : credit card
    M : points
    G : bank transfer
    C : mobile
    D : credits
    Z : COD
    O : digital wallet balance
    V : convenience store
    I : others

    combined_refund_method

    Mixed refund methods

    T : cash
    M : points
    D : credits

    refund_bank_code

    code assigned to bank for refunds

    refund_bank_name

    Max Length : [250]

    Bank name

    refund_bank_account_no

    Max Length : [50]

    Refund account number

    refund_bank_account_holder

    Max Length : [15]

    Refund Account Account Holder's Name

    payment_gateway_cancel

    PG cancellation request settings

    T : cancel
    F : do not cancel

    DEFAULT F

    Definition Copy
    Request example: Copy
    Response example:

    Orders shortagecancellation

    Endpoints 
    POST /api/v2/admin/orders/{order_id}/shortagecancellation

    Orders shortagecancellation properties

    Attribute Description
    shop_no

    Min : [1]

    Shop Number
    order_id

    Order ID
    status

    Order status

    canceled : canceled
    claim_code

    cancellation number
    items

    Order item code

    Create an orders shortagecancellation

    POST

    Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    order_id
    Required

    Order ID

    payment_gateway_cancel

    PG cancellation request settings

    T : cancel
    F : do not cancel

    DEFAULT F

    keep_auto_calculation

    keep the automatic discount calculation flag

    yes: T
    no: F

    DEFAULT F

    collect_gift

    automatically recapture gift

    T: Enable
    F: Disable

    DEFAULT F

    status
    Required

    Order status

    canceled : canceled

    recover_inventory

    Inventory Recovery

    T : Recover
    F : Do not recover

    DEFAULT F

    recover_coupon

    restore a coupon

    T : Recover
    F : Do not recover

    DEFAULT F

    add_memo_too

    add to admin memo

    T: Enable
    F: Disable

    DEFAULT F

    reason

    Max Length : [2000]

    reason for cancellation

    claim_reason_type

    type of reason for cancellation

    A: change of mind
    B: shipping delay
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    G: dissatisfied with service
    H: out of stock
    I: others

    naverpay_cancel_reason_type

    reason for NAVER Pay order cancellation

    This cannot be used on Cafe24 Vietnam, Philippines.

    51 : change of mind
    52 : change color or size
    53 : bought by mistake
    54 : dissatisfied with service or product
    55 : delay in shipping
    56 : out of stock
    60 : different from product details

    refund_method_code

    Refund method

    T : cash
    F : credit card
    M : points
    G : bank transfer
    C : mobile
    D : credits
    Z : COD
    O : digital wallet balance
    V : convenience store
    I : others

    combined_refund_method

    Mixed refund methods

    T : cash
    M : points
    D : credits

    refund_bank_code

    code assigned to bank for refunds

    refund_bank_name

    Max Length : [250]

    Bank name

    refund_bank_account_no

    Max Length : [50]

    Refund account number

    refund_bank_account_holder

    Max Length : [15]

    Refund Account Account Holder's Name

    items

    Order item code

    order_item_code
    Order item code
    Required

    quantity
    Available inventory
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Payments

    Endpoints 
    PUT /api/v2/admin/payments

    Payments properties

    Attribute Description
    shop_no

    Shop Number
    order_id

    Order ID
    status

    Order status

    paid: payment confirmed
    unpaid: awaiting payment
    canceled: payment canceled

    Update payments

    PUT

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    status
    Required

    Order status

    paid: payment confirmed
    unpaid: awaiting payment
    canceled: payment canceled

    recover_inventory

    Inventory Recovery

    T : Recover
    F : Do not recover

    Definition Copy
    Request example: Copy
    Response example:

    Refunds

    Endpoints 
    GET /api/v2/admin/refunds
GET /api/v2/admin/refunds/{refund_code}

    Refunds properties

    Attribute Description
    shop_no

    Shop Number
    member_email

    customer email
    buyer_email

    Buyer Email
    order_date

    timezone

    Ordered date
    accepted_refund_date

    timezone

    refund requested date
    refund_date

    timezone

    refund completed date
    order_id

    Order ID
    refund_code

    refund number
    order_item_code

    list of items
    quantity

    Available inventory
    actual_refund_amount

    actual amount refunded
    used_points

    Reimbursement Return Used
    used_credits

    Deposit Refund Used
    used_transferable_points

    refunded transferable points
    currency

    Currency
    payment_methods

    Payment Method

    cash : deposit without a bankbook
    card : credit card
    cell : mobile
    tcash : bank transfer
    icash : virtual account
    prepaid : digital wallet balance
    credit : credits
    point : points
    pointfy : transferable points
    cvs : convenience store
    cod : COD
    coupon : coupon
    market_discount : market discount
    etc : others
    refund_payment_methods

    refunded in

    cash : deposit without a bankbook
    card : credit card
    cell : mobile
    tcash : bank transfer
    prepaid : digital wallet balance
    credit : credits
    point : points
    pointfy : transferable points
    cvs : convenience store
    cod : COD
    etc : others
    payment_gateway_cancel_status

    PG cancellation status

    F : before cancellation
    M : partially canceled
    T : fully canceled
    payment_gateway_cancel_date

    timezone

    PG canceled date
    status

    status of refund

    T : before refund
    F : refunded
    refund_point

    refunded points

    It can be displayed only in detail inquiry.
    refund_credit

    refunded credits

    It can be displayed only in detail inquiry.
    refund_naver_point

    refunded NAVER points

    It can be displayed only in detail inquiry.
    refund_naver_cash

    refunded NAVER cash

    It can be displayed only in detail inquiry.
    refund_amount

    refund amount

    It can be displayed only in detail inquiry.
    product_price

    Product price

    It can be displayed only in detail inquiry.
    shipping_fee

    shipping fee

    It can be displayed only in detail inquiry.
    shipping_fee_discount_amount

    Shipping discount

    It can be displayed only in detail inquiry.
    cod_fees

    Postpayment Fee

    It can be displayed only in detail inquiry.
    foreign_shipping_additional_fee

    additional handling fee for international shipping

    It can be displayed only in detail inquiry.
    product_discount_amount

    per-product discount

    It can be displayed only in detail inquiry.
    member_group_discount_amount

    customer level-based discount

    It can be displayed only in detail inquiry.
    app_item_discount_amount

    product discount price for app

    It can be displayed only in detail inquiry.
    app_discount_amount

    discount price of order for app

    It can be displayed only in detail inquiry.
    coupon_discount_amount

    coupon discount

    It can be displayed only in detail inquiry.
    product_bundle_discount_amount

    bundle discount

    It can be displayed only in detail inquiry.
    points_spent_amount

    amount of points used

    It can be displayed only in detail inquiry.
    credits_spent_amount

    amount of credits used

    It can be displayed only in detail inquiry.
    transferable_points_spent_amount

    amount of transferable points used

    It can be displayed only in detail inquiry.
    naver_point

    NAVER points

    It can be displayed only in detail inquiry.
    naver_cash

    NAVER cash

    It can be displayed only in detail inquiry.
    additional_product_amount

    price for additional product

    It can be displayed only in detail inquiry.
    manually_input_amount

    manually input amount

    It can be displayed only in detail inquiry.
    changed_refund_amount

    change in refund amount

    It can be displayed only in detail inquiry.
    refund_bank_name

    Bank name

    It can be displayed only in detail inquiry.
    refund_bank_account_no

    Refund account number

    It can be displayed only in detail inquiry.
    refund_bank_account_holder

    Refund Account Account Holder's Name

    It can be displayed only in detail inquiry.
    refund_manager

    refunded by

    It can be displayed only in detail inquiry.
    refund_reason

    refund reason

    It can be displayed only in detail inquiry.
    refund_methods

    refund method

    It can be displayed only in detail inquiry.
    send_sms

    whether send SMS after processing refund

    It can be displayed only in detail inquiry.

    T : send
    F : do not send
    send_mail

    whether send mail after processing refund

    It can be displayed only in detail inquiry.

    T : send
    F : do not send
    items

    Item Resource


    Can search with using embed parameter.

    It can be displayed only in detail inquiry.

    List all refunds

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    start_date
    Required

    Date
    timezone

    Search Start Date

    end_date
    Required

    Date
    timezone

    Search End Date

    date_type

    Date type

    accepted_refund_date : refund requested date
    refund_date : refund completed date

    DEFAULT refund_date

    member_email

    customer email

    buyer_email

    Buyer Email

    limit

    Min : [1]~Max : [500]

    Limit

    DEFAULT 10

    offset

    Max : [8000]

    Start location of list

    Definition Copy
    Request example: Copy
    Response example:

    Get a refund

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    refund_code
    Required

    refund number

    items
    embed

    Item Resource


    Can search with using embed parameter.

    Definition Copy
    Request example: Copy
    Response example:

    Return

    Return refers to a process of returning the order after the product has been delivered to the customer. "Return" resource allows you to retrieve details on returns or process returns. With "Return" resource, you can retrieve order status from after a return request has been submitted to after an order has been returned.

    Endpoints 
    GET /api/v2/admin/return/{claim_code}
POST /api/v2/admin/return

    Return properties

    Attribute Description
    shop_no

    Shop Number
    order_id

    Order ID
    claim_code

    cancellation number
    claim_reason_type

    division

    Type of reason for accepting the customer's return request
    Reason for return request submitted by the customer can be retrieved by using "claim_reason_type" parameter under "items" resource.

    It can be displayed only in detail inquiry.

    A: change of mind
    B: shipping delay
    J: shipping error
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    K: defective product
    G: dissatisfied with service
    H: out of stock
    I: others
    claim_reason

    Reason

    Detailed reason for accepting the customer's return request.
    Reason for return request submitted by the customer can be retrieved by using "claim_reason_type" parameter under "items" resource.

    It can be displayed only in detail inquiry.
    claim_due_date

    Due date for return

    It can be displayed only in detail inquiry.
    return_address

    Return address

    It can be displayed only in detail inquiry.
    pickup

    Pickup - Address

    It can be displayed only in detail inquiry.
    return_invoice_no

    return tracking number

    It can be displayed only in detail inquiry.
    return_shipping_company_name

    return shipping carrier

    It can be displayed only in detail inquiry.
    pickup_request_state

    pickup request status

    It can be displayed only in detail inquiry.

    E: pickup not requested
    W: pickup requested
    S: accepted (awaiting labeling)
    F: pickup request failed
    T: accepted (labeled)
    N: pickup failed
    refund_method

    Refund method

    It can be displayed only in detail inquiry.
    refund_reason

    Remarks

    It can be displayed only in detail inquiry.
    order_price_amount

    Purchase amount

    It can be displayed only in detail inquiry.
    refund_amount

    refund amount

    It can be displayed only in detail inquiry.
    shipping_fee

    shipping fee

    It can be displayed only in detail inquiry.
    return_ship_type

    Return shipping cost classification

    It can be displayed only in detail inquiry.
    return_shipping_fee

    return shipping fee

    It can be displayed only in detail inquiry.
    return_shipping_fee_detail

    return shipping fee details

    It can be displayed only in detail inquiry.
    return_regional_shipping_fee

    return shipping fee by region

    It can be displayed only in detail inquiry.
    return_regional_surcharge_detail

    return shipping fee by region details

    It can be displayed only in detail inquiry.
    defer_commission

    Postpayment Fee

    It can be displayed only in detail inquiry.
    partner_discount_amount

    Affiliate discount cancellation amount

    It can be displayed only in detail inquiry.
    add_discount_amount

    Extra discount discount by product

    It can be displayed only in detail inquiry.
    member_grade_discount_amount

    Membership Discount Discount Amount

    It can be displayed only in detail inquiry.
    shipping_discount_amount

    Shipping discount cancellation amount

    It can be displayed only in detail inquiry.
    coupon_discount_amount

    Coupon discount cancellation amount

    It can be displayed only in detail inquiry.
    point_used

    Reimbursement Return Used

    It can be displayed only in detail inquiry.
    credit_used

    Deposit Refund Used

    It can be displayed only in detail inquiry.
    items

    Order item code
    status

    Order status

    canceled : canceled

    Get a return

    GET

    Specification

    Property Description
    SCOPE mall.read_order
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    claim_code
    Required

    Return number

    Definition Copy
    Request example: Copy
    Response example:

    Create return

    POST

    This API allows you to process returns for multiple orders. When returns are processed by using this API, orders will be marked as returned, but you need to cancel payments via payment gateways.

    For partial returns, refund amount for each order will be automatically calculated and processed.

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 100

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    status
    Required

    Order status

    returned: returned

    recover_inventory

    Inventory Recovery

    T : Recover
    F : Do not recover

    DEFAULT F

    recover_coupon

    restore a coupon

    T : Recover
    F : Do not recover

    DEFAULT F

    add_memo_too

    add to admin memo

    T: Enable
    F: Disable

    DEFAULT F

    reason

    Max Length : [2000]

    refund reason

    claim_reason_type

    type of refund reason

    A: change of mind
    B: shipping delay
    C: unavailable shipping zone
    L: Export/Customs clearance issue
    D: bad packaging
    E: dissatisfied with product
    F:product does not match the description
    G: dissatisfied with service
    H: out of stock
    I: others

    naverpay_return_reason_type

    reason for NAVER Pay order cancellation

    This cannot be used on Cafe24 Vietnam, Philippines, Japan.

    51 : change of mind
    52 : change color or size
    53 : bought by mistake
    54 : dissatisfied with service or product
    55 : delay in shipping
    56 : out of stock
    57 : item missing
    58 : non delivered
    59 : damaged product
    60 : item is different from product details
    61 : shipping error
    62 : delivered wrong item (different product options - e.g.
    wrong color)

    refund_method_code

    Refund method

    T : cash
    F : credit card
    M : points
    G : bank transfer
    C : mobile
    D : credits
    Z : COD
    O : digital wallet balance
    V : convenience store
    I : others

    combined_refund_method

    Mixed refund methods

    When credit card, bank transfer or mobile payment is selected as refund method (refund_method_code), another payment method that will be used to receive refunds for an order paid with multiple payment methods can be selected.

    Note that when the refund amount is smaller than the amount paid via payment gateway, total refund will be processed via the main payment method.

    T : cash
    M : points
    D : credits

    refund_bank_code

    code assigned to bank for refunds

    Required when refund method (refund_method) is set as cash (T)

    refund_bank_code

    Required for Korean stores
    Available only when refund method (refund_method) is set as cash (T)

    refund_bank_name

    Max Length : [250]

    Bank name

    Required when refund method (refund_method) is set as cash (T)

    Required for international stores

    Available only when refund method (refund_method) is set as cash (T)

    refund_bank_account_no

    Max Length : [50]

    Refund account number

    Available only when refund method (refund_method) is set as cash (T)

    refund_bank_account_holder

    Max Length : [15]

    Refund Account Account Holder's Name

    items

    Order item code

    order_item_code
    Order item code
    Required

    quantity
    Available inventory
    Required
    Definition Copy
    Request example: Copy
    Response example:

    Shipments

    This resource, unlike the Order resource's child Shipments resource, lets you create or update multiple orders’ shipping information in one call. This resource contains information about invoice number, courier, shipping status, etc.

    Endpoints 
    POST /api/v2/admin/shipments
PUT /api/v2/admin/shipments

    Shipments properties

    Attribute Description
    shop_no

    Shop Number
    order_id

    Order ID
    tracking_no

    Tracking number
    shipping_code

    Shipping code
    shipping_company_code

    shipping carrier code

    shipping_company_code
    status

    Order status

    standby : waiting for shipping
    shipping : on delivery
    shipped : delivered
    order_item_code

    Order item code
    status_additional_info

    Order status additional info

    Create shipments

    POST

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 100

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    order_id
    Required

    Order ID

    tracking_no
    Required

    Max Length : [30]

    Tracking number

    shipping_company_code
    Required

    shipping carrier code

    shipping_company_code

    status
    Required

    Order status

    standby : waiting for shipping
    shipping : on delivery

    order_item_code

    Order item code

    shipping_code

    Shipping code

    Definition Copy
    Request example: Copy
    Response example:

    Update shipments

    PUT

    You can update shipping information (shipping status, etc.).

    Specification

    Property Description
    SCOPE mall.write_order
    Request Limit 40
    objects per single API call Limit 100

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    status

    Order status

    "tracking_no" and "shipping_company_code" cannot be used when "status" is used to change the shipping status.

    standby : waiting for shipping
    shipping : on delivery
    shipped : delivered

    status_additional_info

    Max Length : [30]

    Order status additional info

    order_id
    Required

    Order ID

    shipping_code
    Required

    Shipping code

    tracking_no

    Max Length : [30]

    Tracking number

    "shipping_company_code" must be used with "tracking_no", and "status" cannot be used to change the shipping status.

    shipping_company_code

    shipping carrier code

    Both shipping carrier and tracking number of the order can be changed.

    shipping_company_code

    "shipping_company_code" should be used when "tracking_no" is used, and "status" cannot be used to edit a tracking number.

    Definition Copy
    Request example: Copy
    Response example:

    Community

    Boards

    Endpoints 
    GET /api/v2/admin/boards

    Boards properties

    Attribute Description
    shop_no

    Shop Number
    board_no

    board number
    board_type

    board category

    1: administration
    2: general
    3: resources
    4: others
    5: product
    6: photo gallery
    7: My inquiries
    11: memo
    board_name

    board name
    use_additional_board

    whether to add more boards

    T: additional board
    F: default board
    use_board

    whether to use board

    T: Use
    F: Do not use
    use_display

    whether to display

    T: Displayed
    F: Not displayed
    display_order

    Order by

    List all boards

    GET

    This API can only be used in stores using Korean or Japanese.

    Specification

    Property Description
    SCOPE mall.read_community
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    Definition Copy
    Request example: Copy
    Response example:

    Boards articles

    Boards articles refers to data on posts posted on [Boards].

    Endpoints 
    GET /api/v2/admin/boards/{board_no}/articles
POST /api/v2/admin/boards/{board_no}/articles
PUT /api/v2/admin/boards/{board_no}/articles/{article_no}
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

    Boards articles properties

    Attribute Description
    shop_no

    Shop Number
    article_no

    posts number
    parent_article_no

    posts number of parent posts
    board_no
    Required

    board number
    product_no

    Product number
    category_no

    category number
    board_category_no

    category number of a board
    reply_sequence

    order of replied posts
    reply_depth

    answer depth
    created_date

    Date
    timezone

    date of create
    writer

    writer
    writer_email

    Email

    email of writer
    member_id

    Member id
    title

    subject
    content

    content
    client_ip

    IP

    IP address of a writer
    nick_name

    nickname
    rating

    Min : [1]~Max : [5]

    review score
    sales_channel

    Max Length : [20]

    sales channel
    reply_mail

    whether replied by mail for 1:1 query

    Y : used
    N : do not used
    display

    post publishing settings

    T: publish
    F: unpublish
    secret

    whether secret posts

    T: Use
    F: Do not use
    notice

    whether notice

    T: Use
    F: Do not use
    fixed

    whether fixed

    T: Use
    F: Do not use
    deleted

    whether deleted

    T : deleted
    F : not deleted
    input_channel

    posting path

    P : PC
    M : mobile
    order_id

    Order ID
    attach_file_urls

    attached file detail
    hit

    views
    reply

    whether replied for 1:1 query

    T: Use
    F: Do not use
    reply_user_id

    manager ID of which processing or completed answer
    reply_status

    status of replay

    N : before answer
    P : processing
    C : completed answer
    naverpay_review_id

    review ID of Naver Pay
    display_time

    Exposure time settings
    display_time_start_hour

    Exposure start time
    display_time_end_hour

    Exposure end time
    attached_file_detail

    attached file detail
    attached_file_urls

    attached file detail

    List all boards articles

    GET

    This API can only be used in stores using Korean or Japanese.

    Specification

    Property Description
    SCOPE mall.read_community
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    board_no
    Required

    board number

    board_category_no

    category number of a board

    start_date

    Date
    timezone

    Creation start date

    end_date

    Date
    timezone

    Creation end date

    input_channel

    Types of online stores

    P: PC
    M: Mobile

    search

    Search scope

    subject: title
    content: content
    writer_name : author
    product : product name
    member_id : customer ID

    keyword

    Keyword

    reply_status

    Answered

    N: Unanswered
    P: Answer

    comment

    Comments

    T: Yes
    F: No

    attached_file

    Attachment

    T: Yes
    F: No

    article_type

    type of post

    You can search multiple item with ,(comma)

    all: all
    normal: general
    notice: notice
    fixed: pinned

    product_no

    Product number

    has_product

    include product information

    T: Yes
    F: No

    limit

    Min : [1]~Max : [100]

    Limit

    DEFAULT 10

    offset

    Max : [8000]

    Start location of list

    Definition Copy
    Request example: Copy
    Response example:

    Create boards articles

    POST

    This API can only be used in stores using Korean or Japanese.

    Specification

    Property Description
    SCOPE mall.write_community
    Request Limit 40
    objects per single API call Limit 10

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    board_no
    Required

    board number

    writer
    Required

    Max Length : [100]

    writer

    title
    Required

    Max Length : [256]

    subject

    content
    Required

    content

    client_ip
    Required

    IP

    IP address of a writer

    reply_article_no

    replied post number

    created_date

    Date
    timezone

    date of create

    writer_email

    Email

    email of writer

    member_id

    Max Length : [20]

    Member id

    notice

    whether notice

    T: Use
    F: Do not use

    DEFAULT F

    fixed

    whether fixed

    T: Use
    F: Do not use

    DEFAULT F

    deleted

    whether deleted

    T : deleted
    F : not deleted

    DEFAULT F

    reply

    whether replied for 1:1 query

    T: Use
    F: Do not use

    DEFAULT F

    rating

    Min : [1]~Max : [5]

    review score

    sales_channel

    Max Length : [20]

    sales channel

    secret

    whether secret posts

    T: Use
    F: Do not use

    DEFAULT F

    password

    password of posts

    reply_mail

    whether replied by mail for 1:1 query

    Y : used
    N : do not used

    DEFAULT N

    board_category_no

    category number of a board

    nick_name

    Max Length : [50]

    nickname

    input_channel

    posting path

    P : PC
    M : mobile

    DEFAULT P

    reply_user_id

    manager ID of which processing or completed answer

    reply_status

    status of replay

    N : before answer
    P : processing
    C : completed answer

    product_no

    Product number

    category_no

    category number

    order_id

    Order ID

    Order ID

    naverpay_review_id

    review ID of Naver Pay

    attach_file_urls

    attached file detail

    name
    filename

    url
    url of file
    Definition Copy
    Request example: Copy
    Response example:

    Update a boards article

    PUT

    This API can only be used in stores using Korean or Japanese.

    Specification

    Property Description
    SCOPE mall.write_community
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    board_no
    Required

    board number

    article_no
    Required

    posts number

    title

    Max Length : [256]

    subject

    content

    content

    rating

    Min : [1]~Max : [5]

    review score

    sales_channel

    Max Length : [20]

    sales channel

    board_category_no

    category number of a board

    display

    post publishing settings

    T: publish
    F: unpublish

    notice

    whether notice

    T: Use
    F: Do not use

    fixed

    whether fixed

    T: Use
    F: Do not use

    display_time_start_hour

    Exposure start time

    display_time_end_hour

    Exposure end time

    attach_file_url1

    URL

    url of file

    attach_file_url2

    URL

    url of file

    attach_file_url3

    URL

    url of file

    attach_file_url4

    URL

    url of file

    attach_file_url5

    URL

    url of file

    Definition Copy
    Request example: Copy
    Response example:

    Delete a boards article

    DELETE

    This API can only be used in stores using Korean or Japanese.

    Specification

    Property Description
    SCOPE mall.write_community
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    board_no
    Required

    board number

    article_no
    Required

    posts number

    Definition Copy
    Request example: Copy
    Response example:

    Boards articles comments

    Endpoints 
    GET /api/v2/admin/boards/{board_no}/articles/{article_no}/comments
POST /api/v2/admin/boards/{board_no}/articles/{article_no}/comments
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}/comments/{comment_no}

    Boards articles comments properties

    Attribute Description
    shop_no

    Shop Number
    board_no

    board number
    article_no

    posts number
    comment_no

    Comment number
    content

    comment content
    writer

    Max Length : [100]

    writer
    member_id

    Max Length : [20]

    Member id
    created_date

    Date
    timezone

    date of create
    client_ip

    IP

    IP address of a writer
    rating

    Min : [1]~Max : [5]

    comment rating
    secret

    whether secret posts

    T: Use
    F: Do not use
    parent_comment_no

    parent comment number
    input_channel

    Types of online stores

    P: PC
    M: Mobile

    List all boards articles comments

    GET

    Specification

    Property Description
    SCOPE mall.read_community
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Min : [1]

    Shop Number

    DEFAULT 1

    board_no
    Required

    board number

    article_no
    Required

    posts number

    comment_no

    Comment number

    limit

    Min : [1]~Max : [100]

    Limit

    DEFAULT 10

    offset

    Max : [8000]

    Start location of list

    Definition Copy
    Request example: Copy
    Response example:

    Create a boards articles comment

    POST

    Specification

    Property Description
    SCOPE mall.write_community
    Request Limit 40
    objects per single API call Limit 1

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    board_no
    Required

    board number

    article_no
    Required

    posts number

    content
    Required

    comment content

    writer
    Required

    Max Length : [100]

    writer

    password
    Required

    Length Min : [1]~Max : [20]

    comment password

    member_id

    ID
    Max Length : [20]

    Member id

    rating

    Min : [1]~Max : [5]

    comment rating

    secret

    whether secret posts

    T: Use
    F: Do not use

    DEFAULT F

    parent_comment_no

    Min : [1]

    parent comment number

    input_channel

    Types of online stores

    P: PC
    M: Mobile

    DEFAULT P

    created_date

    Date
    timezone

    date of create

    Definition Copy
    Request example: Copy
    Response example:

    Delete a boards articles comment

    DELETE

    Specification

    Property Description
    SCOPE mall.write_community
    Request Limit 40

    Request

    Parameter Description
    shop_no

    Shop Number

    DEFAULT 1

    board_no
    Required

    board number

    article_no
    Required

    posts number

    comment_no
    Required

    Comment number

    Definition Copy