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
{
=======
REST API Documentation - CAFE24 REST API 
닫기 
Store
Product
- Bundleproducts
- Categories products
- Mains products
- Products
- Products additionalimages
- Products approve
- Products decorationimages
- Products discountprice
- Products hits
- Products icons
- Products images
- Products memos
- Products options
- Products seo
- Products tags
- Products variants
- Products variants inventories
Order
- Cancellation
- Cashreceipt
- Cashreceipt cancellation
- Collectrequests
- Exchange
- Orders
- Orders autocalculation
- Orders benefits
- Orders buyer
- Orders buyer history
- Orders calculation
- Orders cancellation
- Orders coupons
- Orders exchange
- Orders exchangerequest
- Orders inflowgroups
- Orders inflowgroups inflows
- Orders items
- Orders memos
- Orders payments
- Orders paymenttimeline
- Orders receivers
- Orders receivers history
- Orders refunds
- Orders return
- Orders saleschannels
- Orders shipments
- Orders shippingfeecancellation
- Orders shortagecancellation
- Payments
- Refunds
- Return
- Shipments
Customer
Community
Design
Promotion
Application
Category
Collection
Supply
Shipping
Salesreport
Personal
Privacy
Mileage
Notification
non-print
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
{
>>>>>>> 469512740771d4476660c2edb283ecfa1e3a2689
"resource": {
"key": "value",
"key": "value"
}
}
Error response example
{
"error": {
"code": "error code",
"message": "error message",
"more_info": {
}
}
<<<<<<< HEAD
}
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.
1. Add search conditions
You can use search conditions by adding parameters to an endpoint.
If you want to use multiple search conditions, separate them with ampersands (&).
You can also specify a date and time if it is supported by the API you are using.
Add search conditions
E.g. When searching for products of which price is KRW 1,000 or higher in a certain brand
=======
}
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.
1. Add search conditions
You can use search conditions by adding parameters to an endpoint.
If you want to use multiple search conditions, separate them with ampersands (&).
You can also specify a date and time if it is supported by the API you are using.
Add search conditions
E.g. When searching for products of which price is KRW 1,000 or higher in a certain brand
>>>>>>> 469512740771d4476660c2edb283ecfa1e3a2689
GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000
E.g. When searching for products by specifying the date range in which they were added
GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03
E.g. When searching for products by specifying the date range in which they were edited
GET https://{mallid}.cafe24api.com/api/v2/products?updated_start_date=2018-01-03T14:01:26+09:00&updated_end_date=2018-02-03T14:01:26+09:00
2. Use commas to search for more than one item
Use commas to search for data for more than one item. (You can search for up to 100 items in one query.)
The search conditions separated by commas are OR conditions; You can view all data corresponding to the conditions.
Use commas to search for more than one item
E.g. When searching for products by specifying their product numbers
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13
E.g. When searching for products by specifying their product numbers and product codes
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13&product_code=P000000X,P000000W
3. View multi-language store information
You can search for the information of a localized store by specifying its multi-language store number.
If you don't, the information of the default store will be shown.
View multi-language store information
E.g. When searching for products in a certain localized store
GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2
4. Retrieve single item & details
You can retrieve the details of a resource by specifying its ID.
You can only search for the details of one single product in one query
but you can retrieve more details than when you search for multiple products.
Retrieve single item & details
E.g. When retrieving the details of a product by specifying its product number
GET https://{mallid}.cafe24api.com/api/v2/admin/products/128
E.g. When retrieving the details of one single product by specifying its product number
GET https://{mallid}.cafe24api.com/api/v2/admin/products?product_no=128
5. Pagination
If there are too many results, you define the number of details returned in one response with the "limit" parameter.
If you are not able to view all details with the maximum value of the "limit" parameter, you can use the "offset" parameter.
Pagination
E.g. When paging the details of 100 products at a time
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100
E.g. When retrieving details from the 201st to the 300th product
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100&offset=200
6. Retrieve specific items
Use the "fields" parameter to view specific details
Retrieve specific items
E.g. When retrieving the product name and product name only
GET https://{mallid}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no
7. View sub-resources
If supported by the API you are using, you can search for the data for sub-resources with the "embed" parameter.
View sub-resources
E.g. When searching for the variants and stock of a product
<<<<<<< HEAD
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 2022-06-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
=======
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
>>>>>>> 469512740771d4476660c2edb283ecfa1e3a2689
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": "2021-03-01T14:00:00.000",
"refresh_token": "JeTJ7XpnFC0P..........",
"refresh_token_expires_at": "2021-03-15T12:00:00.000",
"client_id": "BrIfqEKoPxeE..........",
"mall_id": "yourmall",
"user_id": "test",
"scopes": [
"mall.read_order",
"mall.read_product",
"mall.read_store",
"...etc...",
],
"issued_at": "2021-03-01T12:00:00.000"
}
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": "21EZes0dGSfN..........",
"expires_at": "2021-03-01T15:50:00.000",
"refresh_token": "xLlhWztQHBik............",
"refresh_token_expires_at": "2021-03-15T13:50:00.000",
"client_id": "BrIfqEKoPxeE..........",
"mall_id": "yourmall",
"user_id": "test",
"scopes": [
"mall.read_order",
"mall.read_product",
"mall.read_store",
"...etc...",
],
"issued_at": "2021-03-01T13:50:00.000"
<<<<<<< HEAD
}
Store
Activitylogs
Activity log is a record of activities performed by admin user upon managing the mall.
The activity log resource allows you to create or retrieve activity logs of the mall.
Retrieve a list of action logs
GET /api/v2/admin/activitylogs
GET
Retrieve activity logs as a list.
Check who performed the operation in which menu and when.
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description manager_type account type
P: head admin
A: sub-admin
S: supplier
manager_id
Type : [a-z0-9]
Length Min : [4]~Max : [16]
account
mode mode
P: advanced mode
S: smart mode
M: mobile
type division
content
Max Length : [500]
action
start_date
Required
timezone
Search Start Date
end_date
Required
timezone
Search End Date
offset
Max : [8000]
Start location of list
DEFAULT 0
limit
Min : [1]~Max : [100]
Limit
DEFAULT 10
Retrieve an action log
GET /api/v2/admin/activitylogs/{process_no}
GET
Search the activity log in detail.
Check who performed the operation in which menu and when. Check details of the operation conducted.
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description process_no
Required action number
Coupons setting
Coupons setting properties
Attribute Description shop_no
Min : [1]
Shop Number
use_coupon enable coupons
T: yes
F: no
available_issue_type allowed coupon type at checkout
A: both checkout and product coupons
O: checkout coupons only
P: product coupons only
allow_using_coupons_with_points allow using points with coupons
T: yes
F: no
allow_using_coupons_with_discounts allow using customer tier based-discounts with coupons
A: allow both
C: allow coupons only
G: allow customer tier-based discounts only
allow_using_product_and_order_coupons allow using product coupons and checkout coupons together
T: yes
F: no
recover_coupon_setting auto-restore coupons for
max_coupon_count limit number of coupon uses for
use_additional_coupon additional coupon
T: yes
F: no
additional_coupon_no additional coupon number
show_coupon_to_non_members display coupons to guests
T: yes
F: no
show_group_coupon_to_non_members including coupons issued for specific customer tiers
T: Included
F: Not included
show_issued_coupon display coupons already downloaded
T: yes
F: no
sorting_type sort coupons by
A: coupon start date
B: coupon end date
C: coupon issued date
D: amount of discount/points issued
E: discount/points issuance rate
download_image_type default download button image
1:TYPE1
2:TYPE2
3:TYPE3
4:TYPE4
5:TYPE5
background_image_type default background image
1:TYPE1
2:TYPE2
3:TYPE3
4:TYPE4
5:TYPE5
Update coupon settings
PUT /api/v2/admin/coupons/setting
PUT
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
use_coupon enable coupons
T: yes
F: no
available_issue_type allowed coupon type at checkout
A: both checkout and product coupons
O: checkout coupons only
P: product coupons only
allow_using_coupons_with_points allow using points with coupons
T: yes
F: no
allow_using_coupons_with_discounts allow using customer tier based-discounts with coupons
A: allow both
C: allow coupons only
G: allow customer tier-based discounts only
allow_using_product_and_order_coupons allow using product coupons and checkout coupons together
T: yes
F: no
recover_coupon_setting auto-restore coupons for
restore_viewpoint
A: once cancellations/exchanges/returns are complete
B: once cancellations/exchanges/returns are acceptedauto-restore coupons
cancel_before_pay
T: yes
F: no
M: always askcancellations before payment
cancel_after_pay
T: yes
F: no
M: always askcancellations after payment
return
T: yes
F: no
M: always askexchanges
exchange
T: yes
F: no
M: always askreturns
part
F: no
M: always askauto-restore coupons for orders partially canceled/returned/exchanged
max_coupon_count limit number of coupon uses for
product_per_product
product coupons per product
order_per_order
checkout coupons per order
product_and_order_per_order
product/checkout coupons per order
product_per_order
product coupons per order
product_and_order_per_day
product/checkout coupons per day
use_additional_coupon additional coupon
T: yes
F: no
additional_coupon_no
Array Max : [5]
additional coupon number
coupon_no
Coupon number
show_coupon_to_non_members display coupons to guests
T: yes
F: no
show_group_coupon_to_non_members including coupons issued for specific customer tiers
T: Included
F: Not included
show_issued_coupon display coupons already downloaded
T: yes
F: no
sorting_type sort coupons by
A: coupon start date
B: coupon end date
C: coupon issued date
D: amount of discount/points issued
E: discount/points issuance rate
download_image_type default download button image
1:TYPE1
2:TYPE2
3:TYPE3
4:TYPE4
5:TYPE5
background_image_type default background image
1:TYPE1
2:TYPE2
3:TYPE3
4:TYPE4
5:TYPE5
Currency
This resource lets you read a store’s currency information and exchange rates.
Endpoints
Currency properties
Attribute Description exchange_rate Exchange rate
standard_currency_code Standard currency code
The currency code used in the shopping mall of the shopping mall. Standard currency refers to the currency commonly used in countries where a shopping mall operator belongs.
standard_currency_symbol Standard currency symbol
The currency symbol used in the shopping mall of the shopping mall. Standard currency refers to the currency commonly used in countries where a shopping mall operator belongs.
shop_currency_code Shopping mall currency code
shop_currency_symbol Shopping mall currency symbol
shop_currency_format Payment currency display method
Dashboard
Endpoints
Dashboard properties
Attribute Description shop_no Shop Number
A unique number assigned to a store using the default store language or other languages
daily_sales_stats Daily sales stats
Daily sales information.
weekly_sales_stats Weekly sales stats
Weekly sales information.
monthly_sales_stats Monthly sales stats
Monthly sales information.
sold_out_products_count Number of the products sold out
Number of soldout products. Counts only for products which using both soldout option and inventory management option.
new_members_count Number of new members
Number of newly signed up customer.
board_list Board list
Board list of a mall.
Files
Upload files
POST /api/v2/admin/files
POST
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 5
Request
Parameter Description source_url
Required
URL
Upload request URL
Update files
PUT /api/v2/admin/files
PUT
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 5
Request
Parameter Description source_url
Required
URL
Upload request URL
file_name
Required Filename
Financials paymentgateway
Financials paymentgateway properties
Attribute Description partner_id PG-issued store ID
payment_gateway_name Payment gateway name
inicis: Inicis
kcp: KCP
allat: Allat
ksnet: KSNET
dacom: Toss Payments
allthegate: alltheGate
settlebank: SettleBank
smartro: Smartro
kicc: KICC
mobilians: KG Mobilians
danal: Danal
contract_date
timezone
PG contract date
setting_date
timezone
PG installation date
bank_code bank code
bank_account_no bank account
status affiliated with kb bank
T: yes
F: no
bank_account_name account holder
payment_method_information settlement details by payment method
Retrieve a list of Payment Gateway contract details
GET /api/v2/admin/financials/paymentgateway
GET
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description payment_gateway_name Payment gateway name
partner_id PG-issued store ID
Financials store
Endpoints
Retrieve the transaction information of a store
GET /api/v2/admin/financials/store
GET
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
payment_method
Required payment method code
card: credit card
tcash: bank transfer
icash: virtual account
cell: mobile
deferpay: COD
cvs: convenience store
point: digital wallet balance
etc: others
Images setting
Retrieve or update product image size settings.
Update product image size settings
PUT /api/v2/admin/images/setting
PUT
Update product image size settings.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
product_image_size
Required Product image size settings
detail_image_width
Detail image width
detail_image_height
Detail image height
list_image_width
List image width
list_image_height
List image height
tiny_image_width
Tiny list image width
tiny_image_height
Tiny list image height
zoom_image_width
Zoomed-in image width
zoom_image_height
Zoomed-in image height
small_image_width
Small image width
small_image_height
Small image height
Kakaopay setting
Kakaopay setting properties
Attribute Description shop_no Shop Number
shop_key Unique identifier of the store
pixel_code Kakao Advertising Pixel ID being used by the store (ECP/non-ECP)
use_kakaopay Enable Kakao Pay
T: Yes
F: No
product_detail_button_size Product details page button size
basket_button_size Shopping cart page button size
use_dark_mode Enable dark mode
T: Yes
F: No
button_authorization_key Button authorization key of the store
thirdparty_agree Agree to provide info to third parties
T : Yes
F : No
thirdparty_agree_date
timezone
Date of consent to provision of information to third party
Retrieve settings for KakaoPay orders
GET /api/v2/admin/kakaopay/setting
GET
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
Update settings for KakaoPay orders
PUT /api/v2/admin/kakaopay/setting
PUT
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
shop_key Unique identifier of the store
pixel_code Kakao Advertising Pixel ID being used by the store (ECP/non-ECP)
use_kakaopay Enable Kakao Pay
T: Yes
F: No
product_detail_button_size Product details page button size
basket_button_size Shopping cart page button size
use_dark_mode Enable dark mode
T: Yes
F: No
button_authorization_key Button authorization key of the store
thirdparty_agree Agree to provide info to third parties
T : Yes
F : No
thirdparty_agree_date
timezone
Date of consent to provision of information to third party
Menus
Endpoints
Retrieve menus
GET /api/v2/admin/menus
GET
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
mode Mode
pro: Advanced mode
smart: Smart Mode
mobile_admin: Mobile admin
DEFAULT pro
menu_no Menu number
You can search multiple item with ,(comma)
contains_app_url Include app URL
T: Yes
F: No
Mobile setting
A resource about a mobile store's settings.
Endpoints
Naverpay setting
Retrieve Naver Pay settings
GET /api/v2/admin/naverpay/setting
GET
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
Update Naver Pay settings
PUT /api/v2/admin/naverpay/setting
PUT
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
authentication_key
Type : [a-zA-Z0-9_-]
Max Length : [50]
Naver common authentication key
Orders setting
Retrieve and update order settings for automatic recovery of inventory and discount / point amount upon cancellation/return.
Orders setting properties
Attribute Description shop_no
Min : [1]
Shop Number
stock_recover Automatically recover stock for a canceled/returned item
T: General settings F: Individual settings
stock_recover_base General settings: Automatically recover stock for a canceled/returned item
T: Automatically recover F: Do not automatically recover M: Ask whether to recover
stock_recover_individual Individual settings: Recover stock for a canceled/returned item
refund_benefit_setting Set discount/point amount for cancellations/exchanges/returns
Update Order settings
PUT /api/v2/admin/orders/setting
PUT
Update settings for discount / point amount upon cancel, exchange & return
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
refund_benefit_setting Set discount/point amount for cancellations/exchanges/returns
F: Display by total amount T: Display by selected item U: Auto-calculate discount amount (Note: Settings applied to orders hence after)
Paymentgateway
Create a Payment Gateway
POST /api/v2/admin/paymentgateway
POST
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
partner_id
Required
Max Length : [50]
PG-issued store ID
additional_information
Array Max : [5]
additional information
key
Additional field key
value
Additional field value
membership_fee_type
Max Length : [4]
subscription fee type
PRE : Prepaid
PAD : Pay after delivery
FREE : Free
Update a Payment Gateway
PUT /api/v2/admin/paymentgateway/{client_id}
PUT
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
client_id
Required
Max Length : [50]
app client ID
partner_id
Max Length : [50]
PG-issued store ID
additional_information
Array Max : [5]
additional information
key
Additional field key
value
Additional field value
membership_fee_type
Max Length : [4]
subscription fee type
PRE : Prepaid
PAD : Pay after delivery
FREE : Free
Delete a Payment Gateway
DELETE /api/v2/admin/paymentgateway/{client_id}
DELETE
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
client_id
Required
Max Length : [50]
app client ID
Paymentgateway paymentmethods
Paymentgateway paymentmethods properties
Attribute Description client_id app client ID
payment_method_code payment method code
payment_method Payment Method
card: credit card
tcash: bank transfer
icash: virtual account
cell: mobile
cvs: convenience store
deferpay: COD
payment_method_name Payment method name
payment_method_url payment method image path
Retrieve a list of Payment Gateway methods
GET /api/v2/admin/paymentgateway/{client_id}/paymentmethods
GET
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description client_id
Required
Max Length : [50]
app client ID
Create a Payment Gateway method
POST /api/v2/admin/paymentgateway/{client_id}/paymentmethods
POST
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description client_id
Required
Max Length : [50]
app client ID
payment_method_code
Required
Max Length : [50]
payment method code
payment_method
Required Payment Method
card: credit card
tcash: bank transfer
icash: virtual account
cell: mobile
cvs: convenience store
deferpay: COD
payment_method_name
Required
Max Length : [50]
Payment method name
payment_method_url
Required
Max Length : [200]
payment method image path
Update a payment method of a Payment Gateway
PUT /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}
PUT
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description client_id
Required
Max Length : [50]
app client ID
payment_method_code
Required
Max Length : [50]
payment method code
payment_method Payment Method
card: credit card
tcash: bank transfer
icash: virtual account
cell: mobile
cvs: convenience store
deferpay: COD
payment_method_name
Max Length : [50]
Payment method name
payment_method_url
Max Length : [200]
payment method image path
Delete a payment method of a Payment Gateway
DELETE /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}
DELETE
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40
Request
Parameter Description client_id
Required
Max Length : [50]
app client ID
payment_method_code
Required
Max Length : [50]
payment method code
Paymentmethods
Endpoints
Retrieve a list of payment methods
GET /api/v2/admin/paymentmethods
GET
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
Paymentmethods paymentproviders
Retrieve a list of providers by payment method
GET /api/v2/admin/paymentmethods/{code}/paymentproviders
GET
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
code
Required payment method code
name Payment gateway name
display Check whether the payment method is displayed
T: yes
F: no
Update the display status of a payment method
PUT /api/v2/admin/paymentmethods/{code}/paymentproviders/{name}
PUT
Access to this API is limited to certain clients only. Please contact Cafe24 Developers to access it.
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
code
Required payment method code
name
Required Payment gateway name
display
Required Check whether the payment method is displayed
T: yes
F: no
Points setting
Endpoints
Points setting properties
Attribute Description shop_no Shop Number
payment_period Points issue date
name Points title
format Display method
round_unit Rounding unit
F: No round-off
0.01: to the nearest hundredth
0.1: to the nearest tenth
1: to the nearest one
10: to the nearest ten
100: to the nearest hundred
1000: to the nearest thousand
round_type Rounding method
A: Round down
B: Round half up
C: Round up
display_type Points format display settings
P: Percentage
W: Amount
WP: Amount/Percentage
PW: Percentage/Amount
Products setting
Endpoints
Products setting properties
Attribute Description shop_no Shop Number
calculate_price_based_on base for price calculation
S: margin per cost
A: margin per price
P: price set for default store
B: product price
price_rounding_unit rounding place for price
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
price_rounding_rule price rounding
L: round down
U: round
C: round up
Shippingmanager
Endpoints
Shops
Shops is information of multi shopping malls that are created when two or more shopping malls are operated. Multi-shopping malls can be created up to 5, and they can be created in different languages and currencies, which can be used to operate multilingual shopping malls.
Shops properties
Attribute Description shop_no Shop Number
default Whether it is the basic shop
Whether shop is default shop or not.
T: default shop
F: not a default shop
shop_name
Max Length : [255]
Shop name
Store name of the multi-language store
business_country_code Business country code
language_code Language code
Default language code of multi shopping mall.
ko_KR: Korean
en_US: English
zh_CN: Chinese (Simplified)
zh_TW: Chinese (Traditional)
ja_JP: Japanese vi_VN : Vietnamese
language_name
Max Length : [20]
Language name
Default language name of multi shopping mall.
currency_code
Type : [A-Z]
Shopping mall currency code
Currency code of multi shopping mall.
South Korean Won (KRW)
United States Dollar (USD)
Japanese Yen (JPY)
Chinese Yuan (CNY)
Taiwan Dollar (TWD)
Euro (EUR)
Brazilian Real (BRL)
Vietnamese Dong (VND)
currency_name Currency name
Currency name of multi shopping mall.
reference_currency_code
Type : [A-Z]
Reference currency code
Reference currency code of multi shopping mall.
South Korean Won (KRW)
United States Dollar (USD)
Japanese Yen (JPY)
Chinese Yuan (CNY)
reference_currency_name Reference currency name
Reference currency name of multi shopping mall.
pc_skin_no Pc skin no
Design number of PC shopping mall.
mobile_skin_no Mobile skin no
Design number of Mobile shopping mall.
base_domain
Max Length : [63]
Base domain
Base domain.
primary_domain
Max Length : [63]
Primary domain
Representative domain of multi shopping mall.
slave_domain Slave domain
Connected domain of shopping mall.
active Active
Whether activating multi shopping mall or not.
T: activated
F: deactivated
timezone time zone
timezone_name time zone information
date_format time zone date format
Year/Month/Day : YYYY-MM-DD
Month/Day/Year : MM-DD-YYYY
Day/Month/Year : DD-MM-YYYY
time_format time zone time format
Hour/Minute/Second : hh:mm:ss
Hour/Minute : hh:mm
use_reference_currency Use a reference currency
Sms setting
Sms setting is a resource about settings for sending and receiving SMS from and to an online store.
Endpoints
Sms setting properties
Attribute Description shop_no Shop Number
use_sms whether use SMS
T: use
F: do not use
exclude_unsubscriber whether exclude SMS rejected recipient
T : exclude
F : include
default_sender default sender id
unsubscribe_phone Free unsubscribe phone number
send_method SMS send method
S: send SMS via split message
L: send LMS(deduct 3 SMS remaining)
Socials apple
Apple login sync settings
PUT /api/v2/admin/socials/apple
PUT
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
use_apple_login Enable Apple login
T: Yes
F: No
client_id
Max Length : [300]
Client ID
team_id
Max Length : [300]
Team ID
key_id
Max Length : [300]
Key ID
auth_key_file_name
Max Length : [30]
Auth Key filename
auth_key_file_contents
Max Length : [300]
Auth Key file content
use_certification Apple login user authentication
T: Yes
F: No
Store
The store can get the basic information of the shopping mall such as shopping mall name, manager information, business registration number and customer center phone number of shopping mall.
Endpoints
Store properties
Attribute Description shop_no Shop Number
A unique number assigned to a store using the default store language or other languages
shop_name Shop name
mall_id Store ID
Shopping mall ID. Also used in store manager's name and used in base domain.
base_domain Base domain
Auto generated and free default domain. You can access the shoopping mall with this domain.
primary_domain Primary domain
A representative domain connected to a shopping mall. It is dispalyed only when connecting representative domains.
company_registration_no Company registration number
The business registration number of the shopping mall issued in the country where the business is located.
company_name Company name
Business name or company name registered at the time of business registration.
president_name CEO
The name of the representative registered at the time of business registration.
company_condition Business
Business registered at business registration.
company_line Business category
Business category registered at business registration.
country Country of business
Name of the country where the business is located.
country_code Country code
zipcode Zipcode
Postal code of your business
address1 Address 1
Business address (city / county / province)
address2 Address 2
Business address (street address)
phone Office phone number
fax Office fax number
email Email
notification_only_email Sender email
mall_url Shopping mall address
mail_order_sales_registration Report mail-order business
Tells whether the online store has registered as a mail-order sales business.
T:Reported
F:Not Reported
mail_order_sales_registration_number Mail-order business report number
missing_report_reason_type Reason of no mail-order business report
If you did not report mail-order business, Its reason.
missing_report_reason Detailed reason of no mail-order business report
If the reason for not report mail-order business is "other", the reason for detail.
about_us_contents About us
A brief introduction to the mall. It is displayed on the company introduction page of the shopping mall.
company_map_url Company map URL
Show a brief map of the mall. It is displayed on the company introduction page of the shopping mall.
customer_service_phone Customer center service/order phone
Customer center call number displayed on the shopping mall page.
customer_service_email Customer center service/order e-mail
Customer center contact email address displayed on shopping mall page.
customer_service_fax Customer center fax number
Customer center fax number displayed on the shopping page.
customer_service_sms Customer center SMS number
Customer center SMS number displayed on the shopping page.
customer_service_hours Customer center operation time
The customer center open hours displayed on the shopping page.
privacy_officer_name Privacy officer's name
The name of the person in charge of personal information protection displayed on the shopping mall page.
privacy_officer_position Privacy officer's position
privacy_officer_department Privacy officer's department
privacy_officer_phone Privacy officer's phone number
The phone number of the person in charge of privacy protection displayed on the shopping mall page.
privacy_officer_email Privacy officer's email address
The e-mail address of the person in charge of privacy protection displayed on the shopping mall page.
contact_us_mobile Whether to display the service inquiry guide in mobile phone
Whether to expose service information to mobile website.
T: Displayed
F: Not displayed
contact_us_contents Service contact information
Details of service contact information exposed on the product detail page.
Store accounts
Endpoints
Store accounts properties
Attribute Description shop_no Shop Number
bank_account_id bank ID (for bank transfer without a bankbook)
bank_name Bank name
bank_code
Max Length : [50]
Bank code
bank_account_no Bank account no
bank_account_holder Bank account holder number
use_account Use classification
T: Use
F: Do not use
Subscription shipments setting
Subscription shipments setting properties
Attribute Description shop_no Shop Number
subscription_no subscription product number
subscription_shipments_name subscription product name
product_binding_type Subscription product
A: all products
P: selected products
C: selected product categories
one_time_purchase Allow one-time purchase
T : Yes
F : No
product_list products selected for subscription delivery
category_list product categories selected for subscription delivery
use_discount Subscription Payments discount settings
T: Used
F: Not used
discount_value_unit Discount standard
P: discount rate
W: discount amount
discount_values Discount amount
related_purchase_quantity number of products settings
T: order quantity-based
F: regardless of order quantity
subscription_shipments_cycle_type delivery frequency option settings
T: Used
F: Not used
subscription_shipments_cycle delivery frequency
1W: 1 week
2W: 2 weeks
3W: 3 weeks
4W: 4 weeks
1M: 1 month
2M: 2 months
3M: 3 months
4M: 4 months
5M: 5 months
6M: 6 months
1Y: 1 year
use_order_price_condition free shipping settings
T: Used
F: Not used
order_price_greater_than Minimum purchase amount for free shipping
include_regional_shipping_rate whether regional shipping charge included
T: Included
F: Not included
shipments_start_date
Min : [1]
Max : [30]
Subscription start date settings
Create a subscription payment rule
POST /api/v2/admin/subscription/shipments/setting
POST
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no Shop Number
DEFAULT 1
subscription_shipments_name
Required
Max Length : [255]
subscription product name
product_binding_type
Required Subscription product
A: all products
P: selected products
C: selected product categories
one_time_purchase Allow one-time purchase
T : Yes
F : No
DEFAULT T
product_list
Array Max : [10000]
products selected for subscription delivery
category_list
Array Max : [1000]
product categories selected for subscription delivery
use_discount
Required Subscription Payments discount settings
T: Used
F: Not used
discount_value_unit Discount standard
P: discount rate
W: discount amount
discount_values
Array Max : [20]
Discount amount
Maximum value when discount_value_unit is P: 100
Maximum value when discount_value_unit is W: 99999999999999
related_purchase_quantity number of products settings
T: order quantity-based
F: regardless of order quantity
subscription_shipments_cycle_type
Required delivery frequency option settings
T: Used
F: Not used
subscription_shipments_cycle
Required delivery frequency
1W: 1 week
2W: 2 weeks
3W: 3 weeks
4W: 4 weeks
1M: 1 month
2M: 2 months
3M: 3 months
4M: 4 months
5M: 5 months
6M: 6 months
1Y: 1 year
use_order_price_condition
Required free shipping settings
T: Used
F: Not used
order_price_greater_than
Max : [99999999999999]
Minimum purchase amount for free shipping
include_regional_shipping_rate whether regional shipping charge included
T: Included
F: Not included
shipments_start_date
Min : [1]
Max : [30]
Subscription start date settings
DEFAULT 3
Update subscription products
PUT /api/v2/admin/subscription/shipments/setting/{subscription_no}
PUT
Specification
Property Description SCOPE mall.write_store Request Limit 40 objects per single API call Limit 1
Request
Parameter Description shop_no Shop Number
DEFAULT 1
subscription_no
Required subscription product number
subscription_shipments_name
Max Length : [255]
subscription product name
product_binding_type Subscription product
A: all products
P: selected products
C: selected product categories
one_time_purchase Allow one-time purchase
T : Yes
F : No
product_list
Array Max : [10000]
products selected for subscription delivery
category_list
Array Max : [1000]
product categories selected for subscription delivery
use_discount Subscription Payments discount settings
T: Used
F: Not used
discount_value_unit Discount standard
P: discount rate
W: discount amount
discount_values
Array Max : [20]
Discount amount
related_purchase_quantity number of products settings
T: order quantity-based
F: regardless of order quantity
subscription_shipments_cycle_type delivery frequency option settings
T: Used
F: Not used
subscription_shipments_cycle delivery frequency
1W: 1 week
2W: 2 weeks
3W: 3 weeks
4W: 4 weeks
1M: 1 month
2M: 2 months
3M: 3 months
4M: 4 months
5M: 5 months
6M: 6 months
1Y: 1 year
use_order_price_condition free shipping settings
T: Used
F: Not used
order_price_greater_than
Max : [99999999999999]
Minimum purchase amount for free shipping
include_regional_shipping_rate whether regional shipping charge included
T: Included
F: Not included
shipments_start_date
Min : [1]
Max : [30]
Subscription start date settings
Taxmanager
Feature on tax manager (MSA) activation info
Endpoints
Users
Users can operate the shopping mall along with the representative admin user of the shopping mall.
You can operate a shopping mall within the authority granted by the representative admin user.
Retrieve a single user or multiple users registered in the mall as a list.
Users properties
Attribute Description user_id Admin ID
Sub-admin ID
user_name Admin name
Sub-admin name
phone
Phone Number
Office phone number
Phone number of sub operator.
email
Email
Email
Email address of sub operator.
ip_restriction_type Restriction on the IP access
Whether use IP restriction or not.
T: Use
F: Do not use
admin_type Operator category
Whether administor is representative operator or sub operator.
P: Representative operator
A: Sub-operator
last_login_date
timezone
Last login date
shop_no
Min : [1]
Shop Number
nick_name Nick name
Nick name of operator.
nick_name_icon_type Nickname icon type of supplier operator
Register nick name icon. You may register manually or may choose sample.
D: manually register icon
S: register sample icon
nick_name_icon_url Nickname icon url of supplier operator
board_exposure_setting exposure setting for board
memo Memo
available Use classification
T: Use
F: Do not use
multishop_access_authority Multi-shopping mall access authority
T: Allow
F: Do not allow
menu_access_authority Menu access authority
detail_authority_setting Detailed authority setting
ip_access_restriction Restriction on the IP access
access_permission Authority to permit the access
T: permission always granted regardless of access permitted time setting
Retrieve a list of admin users
GET /api/v2/admin/users
GET
Retrieve users registered in the mall as a list.
Retrieve information such as user ID, user name, phone number, etc.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description search_type Search type
member_id: member ID
name: member name
keyword Keyword
admin_type Operator category
P: Representative operator
A: Sub-operator
Retrieve admin user details
GET /api/v2/admin/users/{user_id}
GET
Retrieve a user registered in the mall as a list.
Retrieve information such as user name, phone number, email, etc.
Specification
Property Description SCOPE mall.read_store Request Limit 40
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
user_id Admin ID
Product
Bundleproducts
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: Returned
R: Off-season
U: Preowned
E: Display model
F: Refurbished
S: Scratched
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 tiers 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 Age verification
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 list image height
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 tiers 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_calculation Shipping calculation type
A: Auto M: Manual
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.
hits Product hits Resource
Can search with using embed parameter.
seo Product Seo Resource
Can search with using embed parameter.
tags Product Tag Resource
Can search with using embed parameter.
Retrieve a list of bundles
GET /api/v2/admin/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
offset
Max : [8000]
Start location of list
Set the start location of search result.
DEFAULT 0
limit
Min : [1]~Max : [100]
Limit
Set the maximum number of search result.
Example) input '10' shows only '10' result
DEFAULT 10
Retrieve a bundle
GET /api/v2/admin/bundleproducts/{product_no}
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.
Create a bundle
POST /api/v2/admin/bundleproducts
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
Required
composite product number
purchase_quantity
Required
number of purchased bundles
bundle_product_sales
Required bundle discount information
discount_value
Required
bundle discount price
discount_type
Required
P: percentage-based
V: fixed price-basedbundle discount type
discount_round_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 thousandbundle discount round-off unit
discount_round_type
F: round down
R: round off
C: round upbundle discount round-off method
display Whether display
Whether display or not.
T: Display
F: Do not display
DEFAULT F
add_category_no Category no
Register your product in the category you want to display using the category number
category_no
Required
category number
recommend
T: added
F: not addedwhether a product is added to a recommended product category
DEFAULT F
new
T: added
F: not addedwhether a product is added to a new product category
DEFAULT F
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
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
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 list image height
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
Required
Additional field key
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 tiers 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
Required
Product number
interrelated
Required
T: one-way
F: two-waywhether a related product as one-way or 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 Age verification
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 tiers allowed to view the relevant product
Update a bundle
PUT /api/v2/admin/bundleproducts/{product_no}
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
Required
composite product number
purchase_quantity
Required
number of purchased bundles
bundle_product_sales bundle discount information
discount_value
Required
bundle discount price
discount_type
Required
P: percentage-based
V: fixed price-basedbundle discount type
discount_round_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 thousandbundle discount round-off unit
discount_round_type
F: round down
R: round off
C: round upbundle discount round-off method
display Whether display
You can choose product should be displayed or not.
T: Display
F: Do not display
product_condition Product condition
N: New
B: Returned
R: Off-season
U: Preowned
E: Display model
F: Refurbished
S: Scratched
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
Required
category number
recommend
T: added
F: not addedwhether a product is added to a recommended product category
DEFAULT F
new
T: added
F: not addedwhether a product is added to a new product category
DEFAULT F
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 list image height
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
Required
Additional field key
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 tiers 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
Required
T: one-way
F: two-waywhether a related product as one-way or 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 Age verification
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 tiers allowed to view the relevant product
Delete a bundle
DELETE /api/v2/admin/bundleproducts/{product_no}
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.
Categories products
A relational resource that lets you retrieve or update product display order or general display settings.
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
Retrieve a list of products by category
GET /api/v2/admin/categories/{category_no}/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
Retrieve a count of products by category
GET /api/v2/admin/categories/{category_no}/products/count
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
Add products to a category
POST /api/v2/admin/categories/{category_no}/products
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
Update a product in product category
PUT /api/v2/admin/categories/{category_no}/products
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
Delete a product by category
DELETE /api/v2/admin/categories/{category_no}/products/{product_no}
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
Mains products
A relational resource to the Mains resource about main category products’ display order.
Set main category products
POST /api/v2/admin/mains/{display_group}/products
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
Update fixed sorting of products in main category
PUT /api/v2/admin/mains/{display_group}/products
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.
Delete a product in main category
DELETE /api/v2/admin/mains/{display_group}/products/{product_no}
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
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: Returned
R: Off-season
U: Preowned
E: Display model
F: Refurbished
S: Scratched
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_calculation Tax calculation type
A: Auto M: Manual
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_rate
Min : [0]~Max : [100]
Tax rate
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 tiers 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 tiers
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 Age verification
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 list image height
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
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 tiers allowed to view the relevant product
set_product_type Product bundle type
C: integral type. S: assembled type
use_kakaopay Whether to use Kakao Pay
T: Used
F: Not used
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_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
main whether display at main
Displays main display number when display products at main page such as "recommend product" or "new".
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
translated_description Translation information of 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_calculation Shipping calculation type
A: Auto M: Manual
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_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
"D"가 노출되는 경우 이미지 경로 직접 입력으로 업로드한 이미지임.(예외처리된 몰에서만 사용 가능)
A: Register a representative image.
B: Register an individual image.
C: Register through Web FTP.
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.
translated_additional_description Translated additional description
Retrieve a list of products
GET /api/v2/admin/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.
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
product_bundle Product bundle
T: Use
F: Do not use
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.
DEFAULT 0
limit
Min : [1]~Max : [100]
Limit
Set the maximum number of search result.
Example) input '10' shows only '10' result
DEFAULT 10
Retrieve a count of products
GET /api/v2/admin/products/count
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
product_bundle Product bundle
T: Use
F: Do not use
Retrieve a product resource
GET /api/v2/admin/products/{product_no}
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.
Create a product
POST /api/v2/admin/products
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: Returned
R: Off-season
U: Preowned
E: Display model
F: Refurbished
S: Scratched
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
Required
category number
recommend
T: added
F: not addedwhether a product is added to a recommended product category
DEFAULT F
new
T: added
F: not addedwhether a product is added to a new product category
DEFAULT F
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
Required
Option name
value
Required
Option value
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.
translated_description Translation information of product details
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 list image height
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
"D 입력시 이미지 경로를 지정하여 업로드 가능. 단, ini를 통해 예외 처리 필요
장기적으로 솔루션 사양과 맞지 않는 부분이라 제거 예정
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
Required
Additional field key
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 tiers 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"
DEFAULT 0
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
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 transferpayment method of mileage
points_rate
Points issuance rate
points_unit_by_payment
P : percent unit
W : Won unitunit of points by payment method
except_member_points omit additional points issued based on customer tiers
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 Retrieve a list of origins 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
Required
Product number
interrelated
Required
T: one-way
F: two-waywhether a related product as one-way or 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_rate
Min : [0]~Max : [100]
Tax rate
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 Age verification
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 tiers allowed to view the relevant product
use_kakaopay Whether to use Kakao Pay
This cannot be used on Cafe24 Vietnam, Philippines.
T: Used
F: Not used
Update a product
PUT /api/v2/admin/products/{product_no}
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: Returned
R: Off-season
U: Preowned
E: Display model
F: Refurbished
S: Scratched
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
Required
category number
recommend
T: added
F: not addedwhether a product is added to a recommended product category
DEFAULT F
new
T: added
F: not addedwhether a product is added to a new product category
DEFAULT F
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.
translated_description Translation information of product details
translated_additional_description Translated additional description
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 list image height
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
D 입력시 외부 이미지 경로로 업로드 가능
A: Register a representative image.
B: Register an individual image.
C: Register through Web FTP.
additional_information Additional information list
Additional item.
key
Required
Additional field key
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 tiers 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
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 transferpayment method of mileage
points_rate
Points issuance rate
points_unit_by_payment
P : percent unit
W : Won unitunit of points by payment method
except_member_points omit additional points issued based on customer tiers
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
Required
T: one-way
F: two-waywhether a related product as one-way or 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_rate
Min : [0]~Max : [100]
Tax rate
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 Age verification
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 tiers allowed to view the relevant product
use_kakaopay Whether to use Kakao Pay
This cannot be used on Cafe24 Vietnam, Philippines.
T: Used
F: Not used
Delete a product
DELETE /api/v2/admin/products/{product_no}
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.
Products additionalimages
Products additionalimages, a child resource of Products, lets you retrieve additional images of a product.
Create an additional product image
POST /api/v2/admin/products/{product_no}/additionalimages
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
Update an additional product image
PUT /api/v2/admin/products/{product_no}/additionalimages
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
Products approve
API which can only be used when mall using products approval function.
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.
Retrieve a product approval status
GET /api/v2/admin/products/{product_no}/approve
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.
Create a product approval request
POST /api/v2/admin/products/{product_no}/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
Update a product approval status
PUT /api/v2/admin/products/{product_no}/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
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.
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
Retrieve a list of product decoration images
GET /api/v2/admin/products/{product_no}/decorationimages
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.
Set decoration images for a product
POST /api/v2/admin/products/{product_no}/decorationimages
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
timezone
start date of show_date
show_end_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
Update product decoration images
PUT /api/v2/admin/products/{product_no}/decorationimages
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
timezone
start date of show_date
show_end_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
Remove a product decoration image
DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}
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.
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.
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.
Retrieve a count of product views
GET /api/v2/admin/products/{product_no}/hits/count
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.
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.
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
Set icons for a product
POST /api/v2/admin/products/{product_no}/icons
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
Required
code of product icon
Update product icons
PUT /api/v2/admin/products/{product_no}/icons
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
timezone
start date of show_date
show_end_date
timezone
end date of show_date
image_list
Array Max : [5]
list of product icon
code
Required
code of product icon
Products images
Products Images means the pictures or pictures of the products uploaded for sale. Use the Product Image API to upload an image for use in a product description, or upload an image of a product.
Images of the products can be uploaded by encoding to Base64 code.
Products images properties
Attribute Description path Detail image
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 list image height
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 product images
POST /api/v2/admin/products/{product_no}/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 list image height
Reduced image' showing on the bottom side of the product detail page.
small_image Reduced image
Small list image' showing on the recently viewed page.
image_upload_type
Required Image type
You can specify the upload type, whether the image type is representative image or individual image. If you select the representative image (A), uploading the image to the detail image (detail_image) will be reflected in all other images.
A: Register a representative image.
B: Register an individual image.
Delete product images
DELETE /api/v2/admin/products/{product_no}/images
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.
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.
Retrieve a list of product memos
GET /api/v2/admin/products/{product_no}/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.
offset
Max : [8000]
Start location of list
DEFAULT 0
limit
Min : [1]~Max : [100]
Limit
Set the maximum number of search result.
Example) input '10' shows only '10' result
DEFAULT 10
Retrieve a product memo
GET /api/v2/admin/products/{product_no}/memos/{memo_no}
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.
Create a product memo
POST /api/v2/admin/products/{product_no}/memos
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 Memo
Contents of memo. You may input this with HTML..
Update a product memo
PUT /api/v2/admin/products/{product_no}/memos/{memo_no}
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 Memo
Contents of memo. You may input this with HTML..
Delete a product memo
DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}
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.
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.
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
Retrieve a list of product options
GET /api/v2/admin/products/{product_no}/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.
Create product options
POST /api/v2/admin/products/{product_no}/options
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.
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
Required
Option name
option_value Array
option_text
Option value
option_image_file
swatch
option_color
colorchip
option_display_type
S: select box
P: preview
B: text swatch
R: radio buttonOption list type
DEFAULT S
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
Required
custom text field name
additional_option_text_length
Required
1~30
50
100
200character limit for custom text field
required_additional_option
Required
T: required
F: optionalwhether a custom text field is required or optional
DEFAULT T
use_attached_file_option Whether use attached file option
T: Use
F: Do not use
attached_file_option Attached file option
Update product options
PUT /api/v2/admin/products/{product_no}/options
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.
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
Required
Option name
option_value Array
option_text
Option value
option_image_file
swatch
option_link_image
Option-linked image
option_color
colorchip
option_display_type
S: select box
P: preview
B: text swatch
R: radio buttonOption list type
DEFAULT S
original_options Option value before modification
option_name
Required
Option name
option_value Array
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
Required
custom text field name
additional_option_text_length
Required
1~30
50
100
200character limit for custom text field
required_additional_option
Required
T: required
F: optionalwhether a custom text field is required or optional
DEFAULT T
use_attached_file_option Whether use attached file option
T: Use
F: Do not use
attached_file_option Attached file option
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.
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
Retrieve a product's SEO settings
GET /api/v2/admin/products/{product_no}/seo
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.
Update product SEO settings
PUT /api/v2/admin/products/{product_no}/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.
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.
Retrieve a count of a product's product tags
GET /api/v2/admin/products/{product_no}/tags/count
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.
Retrieve a list of a product's product tags
GET /api/v2/admin/products/{product_no}/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.
Create product tags
POST /api/v2/admin/products/{product_no}/tags
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.
Delete a product tag
DELETE /api/v2/admin/products/{product_no}/tags/{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.
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
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.
Retrieve a list of product variants
GET /api/v2/admin/products/{product_no}/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)
Retrieve a product variant
GET /api/v2/admin/products/{product_no}/variants/{variant_code}
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.
Update a product variant
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}
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
Update multiple product variants
PUT /api/v2/admin/products/{product_no}/variants
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
Delete a product variant
DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}
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.
Products variants inventories
Products Variants Inventories refers to the quantity of eligible items available for sale. Products Variants Inventories is available for each variant. If the variants sold out over than Products Variants Inventories, the product becomes out of stock status.
Products variants inventories properties
Attribute Description shop_no Shop Number
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
origin_code Shipping origin code
Retrieve inventory details of a product variant
GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories
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.
Update a product variant inventory
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories
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
origin_code Shipping origin code
Order
Cancellation
Cancellation properties
Attribute Description shop_no Shop Number
order_id Order ID
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
refund_reason Remarks
order_price_amount Purchase amount
refund_amount refund amount
shipping_fee shipping fee
return_ship_type Return shipping cost classification
defer_commission Postpayment Fee
partner_discount_amount Affiliate discount cancellation amount
add_discount_amount Extra discount discount by product
member_grade_discount_amount Membership Discount Discount Amount
shipping_discount_amount Shipping discount cancellation amount
coupon_discount_amount Coupon discount cancellation amount
point_used Reimbursement Return Used
credit_used Deposit Refund Used
undone Undo
T: Yes
F: No
undone_reason_type Reason for undoing
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
undone_reason Reason for undoing (Details)
expose_order_detail display reason in order details
T: yes
F: no
exposed_undone_reason Reason for undoing (Storefront)
items Order item code
include_tax Include tax in prices
T: Yes
F: No
tax Tax information
status Order status
canceled : canceled
recover_inventory Inventory Recovery
T : Recover
F : Do not recover
add_memo_too add to admin memo
T: Enable
F: Disable
Create multiple order cancellations
POST /api/v2/admin/cancellation
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
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 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
Required
Order item code
quantity
Required
Available inventory
Change cancellation details in bulk
PUT /api/v2/admin/cancellation
PUT
Specification
Property Description SCOPE mall.write_order Request Limit 40 objects per single API call Limit 10
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
order_id
Required Order ID
claim_code
Required Cancellation number
recover_inventory
Required Inventory Recovery
T : Recover
F : Do not recover
undone
Required Undo
T : 철회함
add_memo_too
Required add to admin memo
T: Enable
F: Disable
undone_reason_type
Required Reason for undoing
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
undone_reason
Max Length : [2000]
Reason for undoing (Details)
expose_order_detail
Required display reason in order details
T: yes
F: no
exposed_undone_reason
Max Length : [2000]
Reason for undoing (Storefront)
Cancellationrequests
Create a cancellation request for multiple items
POST /api/v2/admin/cancellationrequests
POST
Specification
Property Description SCOPE mall.write_order Request Limit 40 objects per single API call Limit 100
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
order_id
Required Order ID
reason_type
Required type of reason for cancellation
A: change of mind
B: shipping delay
G: dissatisfied with service
I: others
reason
Required
Max Length : [2000]
reason for cancellation
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
refund_bank_account_no Refund account number
refund_bank_account_holder
Max Length : [15]
Refund Account Account Holder's Name
items list of items
order_item_code
Required
Order item code
quantity
Required
Available inventory
Reject a cancellation request for multiple items
PUT /api/v2/admin/cancellationrequests
PUT
Specification
Property Description SCOPE mall.write_order Request Limit 40 objects per single API call Limit 100
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
order_id
Required Order ID
order_item_code
Required Order item code
undone
Required Rejected to accept
T: Yes
reason_type type of 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
reason
Max Length : [2000]
Reason
display_reject_reason Display reason in [Storefront>My Orders]
T: yes
F: no
DEFAULT F
reject_reason
Max Length : [2000]
reason for rejection
Cashreceipt
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
pg_name Requested payment gateway
cash_bill_no Cash receipt serial number
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
Retrieve a list of cash receipts
GET /api/v2/admin/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
timezone
Search Start Date
end_date
Required
timezone
Search End Date
order_id
Order ID
Order ID
You can search multiple item with ,(comma)
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
DEFAULT 0
Create a cash receipt
POST /api/v2/admin/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
Update a cash receipt
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}
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
Cashreceipt cancellation
Update a cash receipt cancellation
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/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
Collectrequests
Update a collection request
PUT /api/v2/admin/collectrequests/{request_no}
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
Draftorders
Endpoints
Draftorders properties
Attribute Description shop_no Shop Number
order_id 주문 번호
payment_amount 가주문 가격 정보
order_from_mobile Mobile type
T: Made on mobile
F: Was not made on mobile
DEFAULT F
payment_method
Max Length : [10]
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
coupon : coupon
market_discount : market discount
etc : others
items Order item list
Create a draft order
POST /api/v2/admin/draftorders
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 10
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
member_id
Max Length : [20]
Member id
order_from_mobile Mobile type
T: Mobile order
F: PC order
DEFAULT F
payment_method
Max Length : [10]
payment method code
cash: bank deposit
card: credit card
icash: virtual transfer
tcash : bank transfer
cell: mobile
deferpay: collect on delivery (COD)
point: points
order_place_id
Type : [a-zA-Z0-9_-]
Max Length : [40]
order channel
self: PC store (for Cafe24 orders only)
mobile: mobile web (for Cafe24 orders only)
mobile_d: mobile app (for Cafe24 orders only)
country_code Country code
payment_gateway_name
Max Length : [20]
PG name
receiver_name
Required
Max Length : [100]
Receiver name
receiver_name_en
Max Length : [100]
Receiver name (English)
receiver_name_furigana
Max Length : [100]
Receiver name (Pronunciation)
receiver_phone
Required Receiver phone number
receiver_cellphone
Required Receiver mobile phone number
receiver_zipcode
Length Min : [2]~Max : [14]
Receiver zip code
receiver_address1 Recipient address 1
receiver_address2 Recipient address 2
receiver_city city
receiver_state state/region
shipping_message Shipping message
buyer_name
Required
Max Length : [100]
Orderer name
buyer_email
Email
Buyer Email
buyer_phone Buyer phone number
buyer_cellphone Buyer mobile number
buyer_zipcode
Required
Length Min : [2]~Max : [14]
Orderer zip code
buyer_address1
Required
Max Length : [250]
Customer address 1
buyer_address2
Required Customer address 2
no_shipping_required Shipping address doesn't exist
T: No
F: Yes
DEFAULT F
buyer_ip
IP
Orderer IP
transaction_id
Max Length : [100]
Card transaction ID
bank_code
Type : [a-z0-9_-]
Bank code
bank_account_no
Max Length : [30]
Bank account no
bank_account_owner_name
Max Length : [100]
Bank account holder number
shipping_type Delivery type
A: Domestic
B: Overseas
send_order_message Whether to send a new order guide message
T: send SMS
F: do not send SMS
DEFAULT F
send_payment_guide_message Whether to send a deposit guide message
T: send SMS
F: do not send SMS
DEFAULT F
send_order_email Whether to send a new order guide mail
T: send SMS
F: do not send SMS
DEFAULT F
clearance_information_type customs clearance information
I: ID
P: Passport number
C: Personal Customs Clearance Code
clearance_information customs clearance information
self_payment_cancel allowed to cancel with API
T: yes
F: no
DEFAULT F
self_payment_cancel_url cancel with API URL
items Order item list
product_no
Required
Product number
product_code
Required
Product code
option_id
Required
Option id
quantity
Required
Order quantity
product_bundle
T: Use
F: Do not useProduct bundle
prepaid_shipping_fee
P: Prepayment
C: Pay after deliveryWhether prepaid shipping fee
product_bundle_no
Set product number
Exchange
Accept exchange request & update exchange status of an order
Exchange properties
Attribute Description shop_no Shop Number
order_id Order ID
claim_code Return 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
claim_due_date Estimated exchange date
receiver Receiver
reshipping_detail reshipping details
pickup Pickup - Address
additional_payment Additional payment
return_invoice_no return tracking number
return_shipping_company_name return shipping carrier
refund_method Refund method
refund_reason Remarks
order_price_amount Purchase amount
refund_amount refund amount
shipping_fee shipping fee
return_ship_type Return shipping cost classification
defer_commission Postpayment Fee
partner_discount_amount Affiliate discount cancellation amount
add_discount_amount Extra discount discount by product
member_grade_discount_amount Membership Discount Discount Amount
shipping_discount_amount Shipping discount cancellation amount
coupon_discount_amount Coupon discount cancellation amount
point_used Reimbursement Return Used
credit_used Deposit Refund Used
undone Undo
T: Yes
F: No
undone_reason_type Reason for undoing
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
undone_reason Reason for undoing (Details)
expose_order_detail display reason in order details
T: yes
F: no
exposed_undone_reason Reason for undoing (Storefront)
items Order item code
exchanged_items Exchanged items
include_tax Include tax in prices
T: Yes
F: No
tax Tax information
status Order status
accept: accept exchange request
collected: picked up
exchanged: complete
awaiting_collection : awaiting pickup
collected : picked up
exchanged : exchanged
recover_inventory Inventory Recovery
T : Recover
F : Do not recover
exchanged_after_collected exchange status after pickup
T: Used
F: Not used
add_memo_too add to admin memo
T: Enable
F: Disable
Create multiple exchanges
POST /api/v2/admin/exchange
POST
Register a status as either accepted or complete for an exchange request.
Specification
Property Description SCOPE mall.write_order Request Limit 40 objects per single API call Limit 100
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
order_id
Required Order ID
status
Required Order status
accept: Exchange request accepted
exchanged: Exchanged
recover_inventory Inventory Recovery
T : Recover
F : Do not recover
DEFAULT F
add_memo_too add to admin memo
T: Enable
F: Disable
DEFAULT F
items Order item code
order_item_code
Required
Order item code
quantity
Required
Available inventory
exchange_variant_code
Exchange product variant code (when exchanging for a different option of the same product)
same_product
Required exchange status
T: exchange for the same product
F: exchange for another product
Update multiple order exchanges
PUT /api/v2/admin/exchange
PUT
Edit a specific order for which an exchange has been requested.
Withdraw multiple exchange requests, enter reasons for withdrawal and restore inventories.
Should a collection request submitted be no longer valid, you must contact the courier directly to cancel the request.
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
claim_code
Required Exchange number
status Order status
awaiting_collection : awaiting pickup
collected : picked up
exchanged : exchanged
recover_inventory Inventory Recovery
T : Recover
F : Do not recover
exchanged_after_collected exchange status after pickup
T: Used
F: Not used
items Order item code
order_item_code
Order item code
undone Undo
T : 철회함
add_memo_too add to admin memo
T: Enable
F: Disable
undone_reason_type Reason for undoing
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
undone_reason
Max Length : [2000]
Reason for undoing (Details)
expose_order_detail display reason in order details
T: yes
F: no
exposed_undone_reason
Max Length : [2000]
Reason for undoing (Storefront)
Exchangerequests
Bulk exchange request API
POST /api/v2/admin/exchangerequests
POST
Specification
Property Description SCOPE mall.write_order Request Limit 40 objects per single API call Limit 100
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
order_id
Required Order ID
reason_type
Required type of reason
A: Change of mind
E: Unsatisfactory product
K: Defective product
J: Shipping error
I: Others
reason
Required
Max Length : [2000]
Reason for exchange
request_pickup request pickup
T: Request pickup
F: Send directly
pickup pickup location details
name
Required
Name
phone
Office phone number
cellphone
Required
Mobile
zipcode
Required
Zipcode
address1
Required
Address 1
address2
Required
Address 2
tracking_no
Max Length : [30]
return tracking number
shipping_company_name
Max Length : [30]
return shipping carrier
refund_bank_code code assigned to bank for refunds
refund_bank_name
Max Length : [250]
Bank name
refund_bank_account_no Refund account number
refund_bank_account_holder
Max Length : [15]
Refund Account Account Holder's Name
items list of items
order_item_code
Required
Order item code
quantity
Required
Available inventory
exchange_items Products for exchange
product_no
Required
Product number
variant_code
Required
Product item code
quantity
Required
Available inventory
Reject an exchange request for multiple items
PUT /api/v2/admin/exchangerequests
PUT
Specification
Property Description SCOPE mall.write_order Request Limit 40 objects per single API call Limit 100
Request
Parameter Description shop_no
Min : [1]
Shop Number
DEFAULT 1
order_id
Required Order ID
order_item_code
Required Order item code
undone
Required Rejected to accept
T: Yes
reason_type type of 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
reason
Max Length : [2000]
Reason
display_reject_reason Display reason in [Storefront>My Orders]
T: yes
F: no
DEFAULT F
reject_reason
Max Length : [2000]
reason for rejection
Orders
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
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_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
transaction_id Card transaction ID
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 marketplace 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.
A: Domestic
B: Overseas
shipping_type_text Delivery type
Description of shipping type. Whether domestic shipping or abroad shipping.
shipping_status Delivery status
F: Awaiting shipment
M: In transit
T: Delivered
W: Shipment on hold
X: Awaiting confirmation
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 payment
T: subscription payment
F: not a subscription payment
items Item Resource
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
include_tax Include tax in prices
T: Yes
F: No
tax_detail Tax details
customer_group_no_when_ordering Customer group number when ordering
Customer group number when order occurred.
benefits Benefits Resource
Can search with using embed parameter.
coupons Coupon Resource
Can search with using embed parameter.
refunds refund details resource
Can search with using embed parameter.
total_discount_amount Total discount
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
purchase_confirmation Whether the order was confirmed as received
Retrieve a list of orders
GET /api/v2/admin/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
timezone
Search Start Date
start date for search
end_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
R13: return accepted - picked up (automatic)
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
N01: exchange accepted – replacement
E12: exchange on hold
E13: exchange accepted - picked up (automatic)
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
payment_status Payment status
F: Awaiting payment
M: Awaiting additional payment
T: Payment confirmed (manually)
A: Payment confirmed (automatically)
P: Payment complete
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 : Ordered date
pay_date : Paid date
shipbegin_da
