non-print
API Index
Introduction
Cafe24 API
Cafe24 Shopping Mall API is an API provided to app store join developers and third-party solution providers to provide services related to shopping malls.
Cafe24 API is a RESTful architecture that provides OAuth 2.0 based authentication system, a standard HTTP request method, a predictable endpoint URL, and an HTTP code based error message.
Request/Response Format
API request and response support JSON format.
For privacy protection purposes, Cafe 24 API only supports HTTPS protocol.
Dates properties are provided in the ISO_8601
format. : YYYY-MM-DDTHH:MM:SS + 09:00
Request Example (search)
Request Example (register/modify)
Right response example
{
"resource": {
"key": "value",
"key": "value"
}
}Error response example
{
"error": {
"code": "error code",
"message": "error message",
"more_info": {
}
}
}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/sampleapiAPI 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- 2) Application/ | Check for the "Content- |
| 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_ | Check whether using valid client_ |
| 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
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:002. 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,P000000W3. 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=24. 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=1285. 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=2006. 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_no7. 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
GET https://{mallid}.cafe24api.com/api/v2/admin/products/570?embed=variants,inventoriesAPI 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/40Versioning
Past Versions are provided in date format to support APIs that are not compatible with (latest) 2023-03-01
User may define which version to use by setting value in the custom header "X-Cafe24-Api-Version". Without this value set, API version will follow version set in the app setup.
App version can be found in below path.
- Developer Center (sign-in) > Apps > App setup > "Version settings" underneath "App credentials"
A version is valid for 1 year since the release of the latest version.
In case your version get expired, oldest version currently valid will be used instead.
Example (request)
Authentication
Get Authentication Code
When requesting a token to be issued, the code used can not be reused and expires one minute after the code is issued.
{mallid} : Enter the appropriate shopping mall ID.
{client_id} : Enter the client_id of the app created in the developer center.
{state} : The value entered above is returned as a value to prevent modulation.
{redirect_anI} : Enter the Redirect URL for the app created by the developer center.
{script} : You can enter the privileges of the resource server to access the access token.
To receive an access token, you must request a cotton access code. The access code is used if the client is in the form of a Web application.
Example (request)
GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}'Example (response)
HTTP/1.1 302 Found
Location: {redirect_uri}?code={authorize_code}&state={state}Get Access Token
You can get a user token to actually call up the API using the issued authentication code.
{mallid} : Enter the corresponding shopping mall ID.
{client_id} : Enter the client_id of the app created in the developer center.
{client_secret} : Enter the client_secret for the app created at the developer center.
{code} : Enter the issued code.
{redirect_anI} : Enter the Redirect URL for the app created by the developer center.
access_token : This is the approach token used by clients to access the resource server.
refresh_token : This token is used to reissue after the approach token expires.
Example (request)
Example (response)
HTTP/1.1 200 OK
{
"access_token": "0iqR5nM5EJIq..........",
"expires_at": "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"
}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_ | account type P: head admin |
| manager_ Type : [a-z0-9] | account |
| mode | mode P : PC Admin |
| type | division |
| content Max Length : [500] | action |
| start_ Required timezone | Search Start Date |
| end_ 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_ Required | action number |
Automessages arguments
Endpoints
Automessages arguments properties
| Attribute | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| name | Variable name |
| description | Description |
| sample | Sample |
| string_ | Maximum count of characters that can be displayed in a variable Char: Display all characters based on defined settings |
| send_ | When variables can be used (Available occasions) |
Automessages setting
Automessages setting properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| use_ | Whether SMS is enabled T: Enabled |
| use_ | Whether Kakao Info-Talk is enabled T: Enabled |
| use_ | Whether push notification is enabled T: Enabled |
| send_ | Automated delivery methods S: SMS |
| send_ | Whether push notification is going to be sent first to customers who opted-in to receive push notifications T: Yes |
Update an automated message
PUT /api/v2/admin/automessages/setting
PUT
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| send_ Required | Automated delivery methods S: SMS |
| send_ | Whether push notification is going to be sent first to customers who opted-in to receive push notifications T: Yes |
Coupons setting
Coupons setting allows you to enter basic settings for coupons to be used in the mall.
Various settings such as coupon discounts, toggling accumulation, restrictions and displays are capable.
Coupons setting properties
| Attribute | Description |
|---|---|
| shop_ Min : [1] | Shop Number |
| use_ | enable coupons T: yes |
| available_ | allowed coupon type at checkout A: both checkout and product coupons |
| allow_ | allow using points with coupons T: yes |
| allow_ | allow using customer tier based-discounts with coupons A: allow both |
| allow_ | allow using product coupons and checkout coupons together T: yes |
| recover_ | auto-restore coupons for |
| max_ | limit number of coupon uses for |
| use_ | additional coupon T: yes |
| additional_ | additional coupon number |
| show_ | display coupons to guests T: yes |
| show_ | including coupons issued for specific customer tiers T: Included |
| show_ | display coupons already downloaded T: yes |
| sorting_ | sort coupons by A: coupon start date |
| download_ | default download button image 1:TYPE1 |
| background_ | default background image 1:TYPE1 |
Retrieve coupon settings
GET /api/v2/admin/coupons/setting
GET
Retrieve setting information such as whether coupons are used or whether coupons and discounts are used at the same time.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
Update coupon settings
PUT /api/v2/admin/coupons/setting
PUT
Update coupon setting information.
You can update information such as whether to use coupons, restrictions on coupon usage, and limiting the number of coupon usage.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| use_ | enable coupons T: yes |
| available_ | allowed coupon type at checkout A: both checkout and product coupons |
| allow_ | allow using points with coupons T: yes |
| allow_ | allow using customer tier based-discounts with coupons A: allow both |
| allow_ | allow using product coupons and checkout coupons together T: yes |
| recover_ | auto-restore coupons for |
| restore_viewpoint cancel_before_pay cancel_after_pay return exchange part | |
| max_ | limit number of coupon uses for |
| product_per_product order_per_order product_and_order_per_order product_per_order product_and_order_per_day | |
| use_ | additional coupon T: yes |
| additional_ Array Max : [5] | additional coupon number |
| coupon_no | |
| show_ | display coupons to guests T: yes |
| show_ | including coupons issued for specific customer tiers T: Included |
| show_ | display coupons already downloaded T: yes |
| sorting_ | sort coupons by A: coupon start date |
| download_ | default download button image 1:TYPE1 |
| background_ | default background image 1:TYPE1 |
Currency
This resource lets you read a store’s currency information and exchange rates.
Endpoints
Currency properties
| Attribute | Description |
|---|---|
| exchange_ | Exchange rate |
| standard_ | 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_ | 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_ | Shopping mall currency code |
| shop_ | Shopping mall currency symbol |
| shop_ | Payment currency display method |
Dashboard
Dashboard is a brief summary of shopping mall operation information such as order status and sales status.
Endpoints
Dashboard properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| daily_ | Daily sales stats Daily sales information. |
| weekly_ | Weekly sales stats Weekly sales information. |
| monthly_ | Monthly sales stats Monthly sales information. |
| sold_ | Number of the products sold out Number of soldout products. Counts only for products which using both soldout option and inventory management option. |
| new_ | Number of new members Number of newly signed up customer. |
| board_ | Board list Board list of a mall. |
Retrieve a dashboard
GET /api/v2/admin/dashboard
GET
Retrieve Dashboard info.
Check info on sales stats, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
Financials paymentgateway
Financials paymentgateway (PG information) provides PG contract information.
Financials paymentgateway properties
| Attribute | Description |
|---|---|
| partner_ | PG-issued store ID |
| payment_ | Payment gateway name inicis: Inicis |
| contract_ timezone | PG contract date |
| setting_ timezone | PG installation date |
| bank_ | bank code |
| bank_ | bank account |
| status | affiliated with kb bank T: yes |
| bank_ | account holder |
| payment_ | settlement details by payment method ※ Define values for payment_method_information subelement |
Retrieve a list of Payment Gateway contract details
GET /api/v2/admin/financials/paymentgateway
GET
Retrieve a list of contract information by PG.
Check PG contract date, settlement info by payment method, etc.
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_ | Payment gateway name |
| partner_ | PG-issued store ID |
Financials store
Provides transaction info by Payment Gateway.
Endpoints
Retrieve the transaction information of a store
GET /api/v2/admin/financials/store
GET
Retrieve transaction info by payment methods.
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_ Min : [1] | Shop Number DEFAULT 1 |
| payment_ Required | payment method code card: credit card |
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_ Min : [1] | Shop Number DEFAULT 1 |
| product_ Required | Product image size settings |
| detail_image_width detail_image_height list_image_width list_image_height tiny_image_width tiny_image_height zoom_image_width zoom_image_height small_image_width small_image_height | |
Kakaoalimtalk setting
Update the Kakao Info-Talk settings
PUT /api/v2/admin/kakaoalimtalk/setting
PUT
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| use_ | Whether Kakao Info-Talk is enabled T: Enabled |
Kakaopay setting
Retrieve or update Kakaopay settings for a mall.
Kakaopay setting properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| shop_ | Unique identifier of the store |
| pixel_ | Kakao Advertising Pixel ID being used by the store (ECP/non-ECP) |
| use_ | Enable Kakao Pay T: Yes |
| product_ | Product details page button size |
| basket_ | Shopping cart page button size |
| use_ | Enable dark mode T: Yes |
| button_ | Button authorization key of the store |
| thirdparty_ | Agree to provide info to third parties T : Yes |
| thirdparty_ timezone | Date of consent to provision of information to third party |
Retrieve settings for KakaoPay orders
GET /api/v2/admin/kakaopay/setting
GET
Retrieve Kakaopay settings for a mall.
Check info on Kakaopay purchase, 3rd party consent, etc.
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_ Min : [1] | Shop Number DEFAULT 1 |
Update settings for KakaoPay orders
PUT /api/v2/admin/kakaopay/setting
PUT
Update Kakaopay settings for a mall.
Update info on Kakaopay purchase, dark-mode activation, etc.
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_ Min : [1] | Shop Number DEFAULT 1 |
| shop_ | Unique identifier of the store |
| pixel_ | Kakao Advertising Pixel ID being used by the store (ECP/non-ECP) |
| use_ | Enable Kakao Pay T: Yes |
| product_ | Product details page button size |
| | |
| basket_ | Shopping cart page button size |
| | |
| use_ | Enable dark mode T: Yes |
| button_ | Button authorization key of the store |
| thirdparty_ | Agree to provide info to third parties T : Yes |
| thirdparty_ timezone | Date of consent to provision of information to third party |
Menus
Menus is a feature dealing with menu modes in a mall.
You can retrieve menu modes & paths. Menu modes are comprised of pro mode, smart mode & mobile admin.
Endpoints
Retrieve menus
GET /api/v2/admin/menus
GET
Retrieve menu modes & paths in a mall.
Check info such as menu mode, menu number & whether app URL is included.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| mode | Mode new_pro: PC Admin DEFAULT new_pro |
| menu_ | Menu number You can search multiple item with ,(comma) |
| contains_ | Include app URL T: Yes |
Mobile setting
A resource on mobile shopping mall settings.
Check info such as whether mobile mall is toggled & if address auto connection is used.
Endpoints
Naverpay setting
Naverpay Setting is a feature to retrieve or update Naverpay common authentication key of a mall.
Naverpay setting properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| authentication_ | Naver common authentication key |
| naverpay_ | Naver Pay integration version |
| shop_ | Naver merchant ID |
| is_ | Display Naver Pay button |
| is_ | Integrate Naver Pay orders |
| is_ | Integrate Naver Pay order reviews |
| is_ | Display Naver pay order reviews |
| is_ | Page redirection when clicking Naver Pay button |
| certi_ | Naver merchant authentication key |
| image_ | Naver Pay button authentication key |
| naver_ | Naver Pay button design for product details page (PC) |
| naver_ | Naver Pay button design for shopping cart page (PC) |
| naver_ | Naver Pay button design for product details page (Mobile) |
| naver_ | Naver Pay button design for shopping cart page (Mobile) |
Retrieve Naver Pay settings
GET /api/v2/admin/naverpay/setting
GET
Retrieve a Naverpay common authentication key of a mall.
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_ Min : [1] | Shop Number DEFAULT 1 |
Create Naver Pay settings
POST /api/v2/admin/naverpay/setting
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_ Min : [1] | Shop Number DEFAULT 1 |
| authentication_ Type : [a-zA-Z0-9_-] | Naver common authentication key |
| naverpay_ | Naver Pay integration version DEFAULT 2.1 |
| shop_ Required | Naver merchant ID |
| is_ | Display Naver Pay button DEFAULT T |
| is_ | Integrate Naver Pay orders DEFAULT T |
| is_ | Integrate Naver Pay order reviews DEFAULT T |
| is_ | Display Naver pay order reviews DEFAULT T |
| is_ | Page redirection when clicking Naver Pay button DEFAULT N |
| certi_ Required | Naver merchant authentication key |
| image_ Required | Naver Pay button authentication key |
| naver_ | Naver Pay button design for product details page (PC) DEFAULT A|1|2 |
| naver_ | Naver Pay button design for shopping cart page (PC) DEFAULT A|1|1 |
| naver_ | Naver Pay button design for product details page (Mobile) DEFAULT MA|1|2 |
| naver_ | Naver Pay button design for shopping cart page (Mobile) DEFAULT MA|1|1 |
Update Naver Pay settings
PUT /api/v2/admin/naverpay/setting
PUT
Update a Naverpay common authentication key of a mall.
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_ Min : [1] | Shop Number DEFAULT 1 |
| authentication_ Type : [a-zA-Z0-9_-] | 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_ Min : [1] | Shop Number |
| claim_ | Settings for customer cancellation exchange and return requests T: Use |
| claim_ | Item display settings for customer cancellation exchange and return requests It can only be checked when the claim_request item is T. S: Display "Basic options" D: Display "Advanced options" |
| claim_ | Request button display settings for customer cancellation exchange and return requests cancel_N10: Request cancellation button (Order status: Order in progress) |
| claim_ | Display request buttons for customer cancellation exchange and return based on order_date: Start displaying buttons from the order date |
| claim_ | Display period for customer cancellation exchange and return request buttons |
| stock_ | Automatically recover stock for a canceled/returned item T: General settings F: Individual settings |
| stock_ | General settings: Automatically recover stock for a canceled/returned item T: Automatically recover F: Do not automatically recover M: Ask whether to recover |
| stock_ | Individual settings: Recover stock for a canceled/returned item |
| claim_ | Settings for auto-accepting customer cancellation exchange and return requests T: Use |
| refund_ | Set discount/point amount for cancellations/exchanges/returns |
| refund_ | Refund settings for cancellation/exchange/return requests S: Process concurrently |
| use_ | Whether “Order in progress” status is in use T: Yes |
| use_ | Whether “Purchase confirmation” button is enabled T: Yes |
| purchase_ | “Purchase confirmation" button applied date |
| use_ | Whether “Automated purchase confirmation” is enabled T: Yes |
| purchase_ | “Automated purchase confirmation” reference date |
| purchase_ | “Automated purchase confirmation” applied date |
Retrieve Order Settings
GET /api/v2/admin/orders/setting
GET
Retrieve order settings such as automatic recovery of inventories upon cancellation/return & prices for discounts/points.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
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_ Min : [1] | Shop Number DEFAULT 1 |
| refund_ | 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) |
| use_ | Whether “Order in progress” status is in use T: Yes |
| use_ | Whether “Purchase confirmation” button is enabled T: Yes |
| purchase_ Date | “Purchase confirmation" button applied date |
| use_ | Whether “Automated purchase confirmation” is enabled T: Yes |
| purchase_ Min : [1]~Max : [30] | “Automated purchase confirmation” reference date |
| purchase_ Date | “Automated purchase confirmation” applied date |
Paymentgateway
With PG (Paymentgateway), you can retrieve, create, update or delete a PG app.
Create a Payment Gateway
POST /api/v2/admin/paymentgateway
POST
Create a new PG (Payment Gateway) for a mall.
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_ Min : [1] | Shop Number DEFAULT 1 |
| partner_ Required Max Length : [50] | PG-issued store ID |
| additional_ Array Max : [5] | additional information |
| key value | |
| membership_ Max Length : [4] | subscription fee type PRE : Prepaid |
Update a Payment Gateway
PUT /api/v2/admin/paymentgateway/{client_id}
PUT
Update a PG (Payment Gateway) registered for a mall.
Update info such as PG franchise ID & whether registration fee is required.
In order to update, Client ID of the PG app is required.
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_ Min : [1] | Shop Number DEFAULT 1 |
| client_ Required Max Length : [50] | app client ID |
| partner_ Max Length : [50] | PG-issued store ID |
| additional_ Array Max : [5] | additional information |
| key value | |
| membership_ Max Length : [4] | subscription fee type PRE : Prepaid |
Delete a Payment Gateway
DELETE /api/v2/admin/paymentgateway/{client_id}
DELETE
Delete a PG (Payment Gateway) registered for a mall.
In order to delete, Client ID of PG app is required.
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_ Min : [1] | Shop Number DEFAULT 1 |
| client_ Required Max Length : [50] | app client ID |
Paymentgateway paymentmethods
PG (Payment Gateway) payment methods is a feature to manage payment methods registered to the mall.
You can create, retrieve, update & delete a payment method for a PG (Payment Gateway).
Paymentgateway paymentmethods properties
| Attribute | Description |
|---|---|
| client_ | app client ID |
| payment_ | payment method code |
| payment_ | Payment Method card: credit card |
| payment_ | Payment method name |
| payment_ | payment method image path |
| available_ | Available Shop Number |
Retrieve a list of Payment Gateway methods
GET /api/v2/admin/paymentgateway/{client_id}/paymentmethods
GET
Retrieve a payment method of a PG (Payment Gateway) registered to the mall.
You can retrieve info such as method, code & name of a payment method.
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_ Required Max Length : [50] | app client ID |
Create a Payment Gateway method
POST /api/v2/admin/paymentgateway/{client_id}/paymentmethods
POST
Create a payment method for a PG (Payment Gateway) installed for a mall.
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_ Required Max Length : [50] | app client ID |
| payment_ Required Max Length : [50] | payment method code |
| payment_ Required | Payment Method card: credit card |
| payment_ Required Max Length : [50] | Payment method name |
| payment_ Required Max Length : [200] | payment method image path Support extension: 'png', 'jpg', 'jpeg' |
| available_ | Available Shop Number |
Update a payment method of a Payment Gateway
PUT /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}
PUT
Update a payment method for a PG (Payment Gateway) installed for a mall.
You may update info such as method, name, etc.
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_ Required Max Length : [50] | app client ID |
| payment_ Required Max Length : [50] | payment method code |
| payment_ | Payment Method card: credit card |
| payment_ Max Length : [50] | Payment method name |
| payment_ Max Length : [200] | payment method image path Support extension: 'png', 'jpg', 'jpeg' |
| available_ | Available Shop Number |
Delete a payment method of a Payment Gateway
DELETE /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}
DELETE
Delete a payment method of a PG (Payment Gateway) registered to the mall.
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_ Required Max Length : [50] | app client ID |
| payment_ Required Max Length : [50] | payment method code |
Paymentmethods
Retrieve payment methods installed for a mall.
Endpoints
Retrieve a list of payment methods
GET /api/v2/admin/paymentmethods
GET
Retrieve a list of payment methods for a mall.
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_ Min : [1] | Shop Number DEFAULT 1 |
Paymentmethods paymentproviders
Retrieve info or update display settings of a payment method set for a mall.
Retrieve a list of providers by payment method
GET /api/v2/admin/paymentmethods/{code}/paymentproviders
GET
Retrieve a payment method info set for a mall.
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_ 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 |
Update the display status of a payment method
PUT /api/v2/admin/paymentmethods/{code}/paymentproviders/{name}
PUT
Update display settings of a payment method set for a mall.
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_ 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 |
Points setting
Manages setting information in regards to using the Points feature
Points setting properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| point_ | Point-issuance criteria C: After delivery |
| payment_ | Points issue date If point-issuance criteria is set to C (After delivery) |
| name | Points title |
| format | Display method |
| round_ | Rounding unit F: No round-off |
| round_ | Rounding method A: Round down |
| display_ | Points format display settings P: Percentage |
| unusable_ | Pending points conversion criteria M: Issue points after the first product delivery date/product purchase confirmation date |
Update points settings
PUT /api/v2/admin/points/setting
PUT
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| point_ | Point-issuance criteria C: After delivery |
| payment_ | Points issue date If point-issuance criteria is set to C (After delivery) |
| name | Points title |
| format | Display method |
| round_ | Rounding unit You can enter only F |
| round_ | Rounding method A: Round down |
| display_ | Points format display settings P: Percentage |
| unusable_ | Pending points conversion criteria M: Issue points after the first product delivery date/product purchase confirmation date |
Products setting
Product setting is a function of set values such as the sale of the product.
Endpoints
Products setting properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| calculate_ | base for price calculation S: margin per cost |
| price_ | rounding place for price F: no round-off |
| price_ | price rounding L: round down |
Redirects
Retrieve a list of redirects
GET /api/v2/admin/redirects
GET
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 10 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| id Min : [1] | Redirect ID |
| path | Redirect path |
| target | Target location |
Create a redirect
POST /api/v2/admin/redirects
POST
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 10 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| path Required | Redirect path |
| target Required | Target location |
Update a redirect
PUT /api/v2/admin/redirects/{id}
PUT
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 10 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| id Required Min : [1] | Redirect ID |
| path | Redirect path |
| target | Target location |
Seo setting
SEO setting is a search engine optimization (SEO) task that exposes shopping malls to the top of search results and increases visitors.
Seo setting properties
| Attribute | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| common_ | Common page title tags |
| common_ | Common page description tags |
| favicon URL | Favicon |
| use_ | Whether Google Search Console is enabled T: Enable |
| google_ | Google Search Console |
| use_ | Whether Naver Search Advisor is enabled T: Enable |
| naver_ | NAVER Search Advisor |
| sns_ URL | Social Share image |
| use_ | Use Twitter Cards T: Enable |
| robots_ | Ban search robots from PC version website |
| mobile_ | Ban search robots from mobile version website |
| use_ | Whether users are redirected to "page doesn't exist" page (PC) T: Enable |
| missing_ | Redirect URL for "page doesn't exist" page (PC) |
| mobile_ | Whether users are redirected to "page doesn't exist" page (Mobile) T: Enable |
| mobile_ | Redirect URL for "page doesn't exist" page (Mobile) |
| use_ | Whether sitemap is enabled T: Enable |
| use_ | Enable RSS feed T: Enable |
| display_ | Group Name |
| header_ | Head HTML (PC) |
| footer_ | Body HTML (PC) |
| mobile_ | Head HTML (Mobile) |
| mobile_ | Body HTML (Mobile) |
Retrieve SEO settings
GET /api/v2/admin/seo/setting
GET
Check the search engine optimization (SEO) settings of the shopping mall.
You can check meta tags, fabicones, search robot access control, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
Update store SEO settings
PUT /api/v2/admin/seo/setting
PUT
Modify the Search Engine Optimization (SEO) settings of the shopping mall.
You can set meta tags, fabicons, search robot access control, and so on.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| common_ | Common page title tags |
| common_ | Common page description tags |
| favicon URL | Favicon |
| use_ | Whether Google Search Console is enabled T: Enable |
| google_ | Google Search Console |
| use_ | Whether Naver Search Advisor is enabled T: Enable |
| naver_ | NAVER Search Advisor |
| sns_ URL | Social Share image |
| use_ | Use Twitter Cards T: Enable |
| robots_ | Ban search robots from PC version website |
| mobile_ | Ban search robots from mobile version website |
| use_ | Whether users are redirected to "page doesn't exist" page (PC) T: Enable |
| missing_ | Redirect URL for "page doesn't exist" page (PC) |
| mobile_ | Whether users are redirected to "page doesn't exist" page (Mobile) T: Enable |
| mobile_ | Redirect URL for "page doesn't exist" page (Mobile) |
| use_ | Whether sitemap is enabled T: Enable |
| use_ | Enable RSS feed T: Enable |
| display_ | Group Name |
| header_ | Head HTML (PC) |
| footer_ | Body HTML (PC) |
| mobile_ | Head HTML (Mobile) |
| mobile_ | Body HTML (Mobile) |
Shippingmanager
Shipping manager is a feature related to Shipping Manager activation information.
You can retrieve the shipping manager's usage information.
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_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| default | Whether it is the basic shop Whether shop is default shop or not. T: default shop |
| shop_ Max Length : [255] | Shop name Store name of the multi-language store |
| business_ | Business country code |
| language_ | Language code Default language code of multi shopping mall. ko_KR: Korean |
| language_ Max Length : [20] | Language name Default language name of multi shopping mall. |
| currency_ Type : [A-Z] | Shopping mall currency code Currency code of multi shopping mall. South Korean Won (KRW) |
| currency_ | Currency name Currency name of multi shopping mall. |
| reference_ Type : [A-Z] | Reference currency code Reference currency code of multi shopping mall. South Korean Won (KRW) |
| reference_ | Reference currency name Reference currency name of multi shopping mall. |
| pc_ | Pc skin no Design number of PC shopping mall. |
| mobile_ | Mobile skin no Design number of Mobile shopping mall. |
| base_ Max Length : [63] | Base domain Base domain. |
| primary_ Max Length : [63] | Primary domain Representative domain of multi shopping mall. |
| slave_ | Slave domain Connected domain of shopping mall. |
| active | Active Whether activating multi shopping mall or not. T: activated |
| timezone | time zone |
| timezone_ | time zone information |
| date_ | time zone date format Year/Month/Day : YYYY-MM-DD |
| time_ | time zone time format Hour/Minute/Second : hh:mm:ss |
| use_ | Use a reference currency |
Retrieve a list of shops
GET /api/v2/admin/shops
GET
You can check the information of multi-shopping malls registered in the shopping mall as a list.
You can check the name of the shopping mall, whether it is a basic shop, and the name of the basic language.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Retrieve a shop
GET /api/v2/admin/shops/{shop_no}
GET
You can inquire the information of the multi-shopping mall registered in the shopping mall.
You can check the name of the shopping mall, language, and payment currency information.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ Required | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
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_ | Shop Number |
| use_ | whether use SMS T: use |
| exclude_ | whether exclude SMS rejected recipient T : exclude |
| default_ | default sender id |
| unsubscribe_ | Free unsubscribe phone number |
| send_ | SMS send method S: send SMS via split message |
Socials apple
Apple ID login is a function related to Apple ID login for shopping mall customers.
To use the Apple ID login settings, you must first complete the Sign in with Apple app settings in Apple's developer account.
Apple login sync settings
PUT /api/v2/admin/socials/apple
PUT
Modify the Apple login link information of customers using the shopping mall.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| use_ | Enable Apple login T: Yes |
| client_ Max Length : [300] | Client ID Identifier set when creating Service ID for Apple Developer Center |
| team_ Max Length : [300] | Team ID Apple Developer Center App ID Prefix |
| key_ Max Length : [300] | Key ID Apple Developer Center Key ID |
| auth_ Max Length : [30] | Auth Key filename Only .p8 files are available as Key files for App ID |
| auth_ Max Length : [300] | Auth Key file content Open the .p8 file as a text file and create a value with no wrap |
| use_ | Apple login user authentication T: Yes |
Socials naverlogin
Naver login details
GET /api/v2/admin/socials/naverlogin
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_ Min : [1] | Shop Number DEFAULT 1 |
Update Naver login settings
PUT /api/v2/admin/socials/naverlogin
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_ Min : [1] | Shop Number DEFAULT 1 |
| use_ Required | Whether Naver login is enabled T: Yes |
| client_ Type : [a-zA-Z0-9] | Client ID |
| client_ Type : [a-zA-Z0-9] | Client secret key |
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_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| shop_ | Shop name Name of the shopping mall of the store ([Shopping mall setting > Preferences > 'Shopping mall information > My shopping mall information']) |
| mall_ | Store ID Shopping mall ID. Also used in store manager's name and used in base domain. |
| base_ | Base domain Auto generated and free default domain. You can access the shoopping mall with this domain. |
| primary_ | Primary domain A representative domain connected to a shopping mall. It is dispalyed only when connecting representative domains. |
| company_ | Company registration number The business registration number of the shopping mall issued in the country where the business is located. |
| company_ | Company name Business name or company name registered at the time of business registration. |
| president_ | CEO The name of the representative registered at the time of business registration. |
| company_ | Business Business registered at business registration. |
| company_ | Business category Business category registered at business registration. |
| country | Country of business Name of the country where the business is located. |
| country_ | 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 |
| Mail address to receive when the operator receives automatic mail | |
| notification_ | Sender email The sender's mail address when sending automatic mail to the customer and operator |
| mall_ | Shopping mall address |
| mail_ | Report mail-order business Tells whether the online store has registered as a mail-order sales business. T:Reported |
| mail_ | Mail-order business report number |
| missing_ | Reason of no mail-order business report If you did not report mail-order business, Its reason. |
| missing_ | Detailed reason of no mail-order business report If the reason for not report mail-order business is "other", the reason for detail. |
| about_ | About us A brief introduction to the mall. It is displayed on the company introduction page of the shopping mall. |
| company_ | Company map URL Show a brief map of the mall. It is displayed on the company introduction page of the shopping mall. |
| customer_ | Customer center service/order phone Customer center call number displayed on the shopping mall page. |
| customer_ | Customer center service/order e-mail Customer center contact email address displayed on shopping mall page. |
| customer_ | Customer center fax number Customer center fax number displayed on the shopping page. |
| customer_ | Customer center SMS number Customer center SMS number displayed on the shopping page. |
| customer_ | Customer center operation time The customer center open hours displayed on the shopping page. |
| privacy_ | Privacy officer's name The name of the person in charge of personal information protection displayed on the shopping mall page. |
| privacy_ | Privacy officer's position |
| privacy_ | Privacy officer's department |
| privacy_ | Privacy officer's phone number The phone number of the person in charge of privacy protection displayed on the shopping mall page. |
| privacy_ | Privacy officer's email address The e-mail address of the person in charge of privacy protection displayed on the shopping mall page. |
| contact_ | Whether to display the service inquiry guide in mobile phone Whether to expose service information to mobile website. T: Displayed |
| contact_ | Service contact information Details of service contact information exposed on the product detail page. |
Retrieve store details
GET /api/v2/admin/store
GET
You can check the information of the shopping mall.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
Store accounts
Store accounts are a function of the shopping mall's unbanked deposit information.
Endpoints
Store accounts properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| bank_ | bank ID (for bank transfer without a bankbook) |
| bank_ | Bank name |
| bank_ Max Length : [50] | Bank code |
| bank_ | Bank account no |
| bank_ | Bank account holder number |
| use_ | Use classification T: Use |
Retrieve a list of store bank accounts
GET /api/v2/admin/store/accounts
GET
You can check the store's bank account information as a list.
You can check the bank name, bank code, account number, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
Subscription shipments setting
Subscription shipments setting is a function of regular delivery through regular payment.
You can set up regular delivery products at shopping malls or check regular delivery products through regular delivery settings.
In order to use the regular delivery function, the regular delivery service must be applied first.
You can apply for regular delivery service at the admin.
Subscription shipments setting properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| subscription_ | subscription product number |
| subscription_ | subscription product name |
| product_ | Subscription product A: all products |
| one_ | Allow one-time purchase T : Yes |
| product_ | products selected for subscription delivery |
| category_ | product categories selected for subscription delivery |
| use_ | Subscription Payments discount settings T: Used |
| discount_ | Discount standard P: discount rate |
| discount_ | Discount amount |
| related_ | number of products settings T: order quantity-based |
| subscription_ | delivery frequency option settings T: Used |
| subscription_ | delivery frequency 1W: 1 week |
| use_ | free shipping settings T: Used |
| order_ | Minimum purchase amount for free shipping |
| include_ | whether regional shipping charge included T: Included |
| shipments_ Min : [1] | Subscription start date settings |
Retrieve a list of subscription products
GET /api/v2/admin/subscription/shipments/setting
GET
You can check the information about the set regular delivery products as a list.
You can check the regular delivery product setting number, setting name, setting value, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| subscription_ | subscription product number |
Create a subscription payment rule
POST /api/v2/admin/subscription/shipments/setting
POST
You can set up regular delivery products.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| subscription_ Required Max Length : [255] | subscription product name |
| product_ Required | Subscription product A: all products |
| one_ | Allow one-time purchase T : Yes DEFAULT T |
| product_ Array Max : [10000] | products selected for subscription delivery |
| category_ Array Max : [1000] | product categories selected for subscription delivery |
| use_ Required | Subscription Payments discount settings T: Used |
| discount_ | Discount standard P: discount rate |
| discount_ Array Max : [20] | Discount amount Maximum value when discount_value_unit is P: 100 |
| related_ | number of products settings T: order quantity-based |
| subscription_ Required | delivery frequency option settings T: Used |
| subscription_ Required | delivery frequency 1W: 1 week |
| use_ Required | free shipping settings T: Used |
| order_ Max : [99999999999999] | Minimum purchase amount for free shipping |
| include_ | whether regional shipping charge included T: Included |
| shipments_ Min : [1] | Subscription start date settings DEFAULT 3 |
Update subscription products
PUT /api/v2/admin/subscription/shipments/setting/{subscription_no}
PUT
You can modify the regular delivery settings for the set regular delivery products.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| subscription_ Required | subscription product number |
| subscription_ Max Length : [255] | subscription product name |
| product_ | Subscription product A: all products |
| one_ | Allow one-time purchase T : Yes |
| product_ Array Max : [10000] | products selected for subscription delivery |
| category_ Array Max : [1000] | product categories selected for subscription delivery |
| use_ | Subscription Payments discount settings T: Used |
| discount_ | Discount standard P: discount rate |
| discount_ Array Max : [20] | Discount amount |
| related_ | number of products settings T: order quantity-based |
| subscription_ | delivery frequency option settings T: Used |
| subscription_ | delivery frequency 1W: 1 week |
| use_ | free shipping settings T: Used |
| order_ Max : [99999999999999] | Minimum purchase amount for free shipping |
| include_ | whether regional shipping charge included T: Included |
| shipments_ Min : [1] | Subscription start date settings |
Delete subscription products
DELETE /api/v2/admin/subscription/shipments/setting/{subscription_no}
DELETE
You can turn off the regular delivery settings for the set regular delivery products.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_store |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| subscription_ Required | subscription product number |
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_ | Admin ID Sub-admin ID |
| user_ | Admin name Sub-admin name |
| phone Phone Number | Office phone number Phone number of sub operator. |
| email | Email address of sub operator. |
| ip_ | Restriction on the IP access Whether use IP restriction or not. T: Use |
| admin_ | Operator category Whether administor is representative operator or sub operator. P: Representative operator |
| last_ timezone | Last login date |
| shop_ Min : [1] | Shop Number |
| nick_ | Nick name Nick name of operator. |
| nick_ | Nickname icon type of supplier operator Register nick name icon. You may register manually or may choose sample. D: manually register icon |
| nick_ | Nickname icon url of supplier operator |
| board_ | exposure setting for board |
| memo | Memo |
| available | Use classification T: Use |
| multishop_ | Multi-shopping mall access authority T: Allow |
| menu_ | Menu access authority |
| detail_ | Detailed authority setting |
| ip_ | Restriction on the IP access |
| access_ | 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_ | Search type member_id: member ID |
| keyword | Keyword |
| admin_ | Operator category P: Representative 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_ Min : [1] | Shop Number DEFAULT 1 |
| user_ | Admin ID ID of the operator or sub-operator |
Product
Bundleproducts
Bunldeproducts refers to a product that sells multiple products in a bundle.
You can set up additional discounts so that you can purchase the set product at a lower price than you can order each product.
When ordering a set product, you can manage the order like a single product.
Set product resources allow you to view only set products, or register/modify/delete set products.
Bundleproducts properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| product_ | Product number A unique serial number assigned to a product. This number cannot be duplicated. |
| product_ Type : [A-Z0-9] | Product code A code assigned to a product by the system. This code cannot be duplicated. |
| bundle_ | composite product information |
| custom_ 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_ 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_ Max Length : [250] | English name of product Product name in English. It can be used for international shipping. |
| supply_ 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_ Max Length : [50] | internal product name |
| model_ Max Length : [100] | Model name Model of the product |
| display | Whether display Whether the product is displayed on the store. T: Display |
| selling | whether selling Whether the product is for sale. T: Sell |
| product_ | Product condition Condition of the product N: New |
| product_ Max : [2147483647] | Months of using the used product |
| summary_ 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_ | Product tag Search terms for searching or categorizing products (hashtags) |
| price_ 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_ | whether purchase restriction individual setting T: use |
| buy_ | Purchase limitation Whether or not to restrict purchase from guest accounts N: Purchase is only available to customer accounts + Buy button is hidden |
| buy_ | customer tiers allowed to purchase the relevant product |
| buy_ | Authorized customer ID |
| repurchase_ | repurchase restriction T : restrict repurchase |
| single_ | single purchase restriction T : restrict single purchase |
| points_ | whether use mileage individual setting F : use default setting |
| points_ | mileage individual setting - lower level item > basic setting mileage or mileage setting according to payment method B : Use the default reserve setting |
| points_ | Mileage setting |
| except_ | Mileage exception T : exclude setting an additional mileage accumulation for member group |
| adult_ | Age verification Whether the product requires adult certification. Customer needs to be authenticated to purchase products that require adult certification. T: Used |
| detail_ | Detail image Detail image' showing on the product detail page. |
| list_ | List image List image' showing on the product category page, main page, product search result page. |
| tiny_ | Tiny list image height Small list image' showing on the recently viewed page. |
| small_ | Reduced image Reduced image' showing on the bottom side of the product detail page. |
| use_ | whether use Naver Pay T: Used |
| naverpay_ | Naver Pay sales type C : Naver Pay + Shopping Mall Products at the same time |
| icon_ | 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. |
| product_ | Weight of product Weight of whole product. Total weight including product, box, and packing weight is necessary for shipping. |
| product_ | 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_ timezone | Created date Date when product registered. |
| updated_ timezone | Updated date Date when product modified. |
| english_ | 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 of product In case cloth products using a Japanese courier service, material information may required for some shipping companies. woven: Woven |
| list_ | Recommend / sold out / new icon expose flag Either showing recommend / sold out / new icon will be exposed or not. |
| sold_ | Whether sold out or stock is available T: Out-of-stock |
| discountprice | Product discount sale price Resource
|
| decorationimages | Decoration Image Resource
|
| benefits | Benefits Resource
|
| additionalimages Array Max : [20] | additional image resource
|
| exposure_ | types of customers allowed to view the relevant product A: display to all |
| exposure_ | customer tiers allowed to view the relevant product |
| bundle_ | bundle discount information |
| category | Category number Category of the product. Product is marked with this category. |
| project_ | planned exhibition number |
| description | Detail description of product Detail description of product. You may input description with HTML. |
| mobile_ | 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_ | add mobile version T: add mobile version product details |
| additional_ 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_ | Payment info Guidance for payment method. You may input this with HTML. |
| shipping_ | Shipping info Guidance for shipping method. You may input this with HTML. |
| exchange_ | Exchange info Guidance for exchange and return method. You may input this with HTML. |
| service_ | Service info Guidance for service warranty information. You may input this with HTML. |
| country_ | HS code by country HS code used for customs duties when shipped overseas. You must enter the correct number for international shipment clearance. |
| simple_ | Simple Product Description Simple description of product. Can Exposed at product display screen. You may input description with HTML. |
| shipping_ | Shipping calculation type A: Auto M: Manual |
| shipping_ | Shipping fee by product Set whether shipping fee will be charged separately or commonly. T: Used |
| shipping_ | Shipping method Following is the method when 'individual_delivery' is TRUE 01: regular delivery |
| prepaid_ | Whether prepaid shipping fee Returns null if shipping_calculation is A (autocomputation). C: Pay after delivery |
| shipping_ | Shipping period (When using 'Shipping charge individually') Average transit time for make a delivery. |
| shipping_ | Shipping information Shows whether can only deliver domestically or can deliver to overseas too. A: Domestic only |
| shipping_ Max Length : [255] | Shipping area (When using 'Shipping charge individually') Available shipping region. |
| shipping_ | 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_ | 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. |
| clearance_ | English name of product Product classification information to use for the purpose of overseas customs clearance. |
| clearance_ | Korean product category for overseas customs clearance Product name as Korean |
| clearance_ Type : [A-Z0-9] | Clearance category code |
| additional_ | Additional information list You may add additional information other than basic information. |
| image_ | Image type Image type when uploading image. A: Register a representative image. |
| main | whether display at main Displays main display number when display products at main page such as "recommend product" or "new". |
| relational_ 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
|
| hits | Product hits Resource
|
| seo | Product Seo Resource
|
| tags | Product Tag Resource
|
Retrieve a list of bundles
GET /api/v2/admin/bundleproducts
GET
You can look up the set product through the list.
You can check the product code, your own product code, product name, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| discountprice embed | Product discount sale price Resource |
| decorationimages embed | Decoration Image Resource |
| benefits embed | Benefits Resource |
| additionalimages embed | additional image resource |
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ | Product number Number of a product. You can search multiple item with ,(comma) |
| display | Whether display T: Display |
| selling | whether selling T: Sell |
| product_ | Product code You can search multiple item with ,(comma) |
| product_ | Product tag You can search multiple item with ,(comma) |
| custom_ | Custom product code You can search multiple item with ,(comma) |
| product_ | Product name You can search multiple item with ,(comma) |
| eng_ | English name of product You can search multiple item with ,(comma) |
| supply_ | Supplier product name You can search multiple item with ,(comma) |
| internal_ | internal product name You can search multiple item with ,(comma) |
| model_ | Model name You can search multiple item with ,(comma) |
| price_ | Minimum price |
| price_ | Maximum price |
| created_ timezone | Registered date start |
| created_ timezone | Registered date end |
| updated_ timezone | Updated date start |
| updated_ timezone | Updated date end |
| category | Category number |
| category_ | Unapplied Category T : Search for products that category unapplied |
| include_ | include sub category T: Included |
| product_ | Weight of product |
| additional_ | additional information key |
| additional_ | additional information value |
| sort | Sort order created_date: Created Date |
| order | Order by asc: Ascending |
| 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. DEFAULT 10 |
Retrieve a bundle
GET /api/v2/admin/bundleproducts/{product_no}
GET
You can check specific set products in detail.
Additional details such as set discount information can be found.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number Number of a product. |
| discountprice embed | Product discount sale price Resource |
| decorationimages embed | Decoration Image Resource |
| benefits embed | Benefits Resource |
| memos embed | Memos Resource |
| hits embed | Product hits Resource |
| seo embed | Product Seo Resource |
| tags embed | Product Tag Resource |
| additionalimages embed | additional image resource |
Create a bundle
POST /api/v2/admin/bundleproducts
POST
Lets you create a set product.
Additional set product discounts can be applied to the price of the bundled product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ Required Max Length : [250] | Product name Name of product. |
| bundle_ Required | composite product information |
| product_no purchase_quantity | |
| bundle_ Required | bundle discount information |
| discount_value discount_type discount_round_unit discount_round_type | |
| display | Whether display Whether display or not. T: Display DEFAULT F |
| add_ | Category no Register your product in the category you want to display using the category number |
| category_no recommend new | |
| custom_ Max Length : [40] | Custom product code You may assign this code manually in case of stock management or other reasons. |
| eng_ Max Length : [250] | English name of product Name of product in english. |
| supply_ Max Length : [250] | Supplier product name |
| internal_ Max Length : [50] | internal product name |
| model_ Max Length : [100] | Model name Model name of product. |
| use_ | whether use Naver Pay This cannot be used on Cafe24 Vietnam, Philippines. T: Used |
| naverpay_ | Naver Pay sales type This cannot be used on Cafe24 Vietnam, Philippines. C : Naver Pay + Shopping Mall Products at the same time |
| product_ Min : [0]~Max : [999999.99] | Weight of product |
| description | Detail description of product Detailed description of product. |
| mobile_ | 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_ Max Length : [255] | Product Summary Description |
| simple_ | Simple Product Description |
| product_ Array Max : [50] | Product tag Tag for search product. |
| payment_ | Payment info Payment method guidance. |
| shipping_ | Shipping info Shipping method guidance. |
| exchange_ | Exchange info Exchange/return method guidance. |
| service_ | 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_ | Shipping information Shows whether can only deliver domestically or can deliver to overseas too. This cannot be used on Cafe24 Vietnam, Philippines. A: Domestic only DEFAULT A |
| shipping_ | Shipping method Shipping method(when shipping individually). 01: regular delivery DEFAULT 01 |
| shipping_ | Shipping fee by product Shipping charge individually. T: Individual delivery DEFAULT F |
| shipping_ Max Length : [255] | Shipping area Shipping area. |
| shipping_ Array Max : [2] | Shipping period Transit time. |
| minimum maximum | |
| shipping_ | 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_ 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. |
| prepaid_ | Whether prepaid shipping fee This cannot be used on Cafe24 Vietnam, Philippines. C: Pay after delivery DEFAULT B |
| clearance_ Type : [A-Z0-9] | Clearance category code Required if shipping information (shipping_scope) is B (domestic / overseas shipping) or C (overseas shipping) |
| detail_ | Detail image Detail image. |
| list_ | List image List image. |
| tiny_ | Tiny list image height |
| small_ | Reduced image |
| image_ | Image type Image type. A: Register a representative image. DEFAULT A |
| additional_ | Additional information list Additional item. |
| key value | |
| price_ Max Length : [20] | Alternative phrase of the selling price |
| buy_ | whether purchase restriction individual setting T: use DEFAULT F |
| buy_ | Purchase limitation N: Purchase is only available to customer accounts + Buy button is hidden DEFAULT F |
| buy_ | customer tiers allowed to purchase the relevant product |
| buy_ | Authorized customer ID |
| repurchase_ | repurchase restriction T : restrict repurchase DEFAULT F |
| single_ | single purchase restriction T : restrict single purchase DEFAULT F |
| points_ | whether use mileage individual setting F : use default setting DEFAULT F |
| points_ | mileage individual setting - lower level item > basic setting mileage or mileage setting according to payment method B : Use the default reserve setting |
| points_ | Mileage setting |
| except_ | Mileage exception T : exclude 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_ 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 interrelated | |
| product_ | 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_ | 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 of product In case cloth products using a Japanese courier service, material information may required for some shipping companies. woven: Woven |
| additional_ | 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. |
| adult_ | Age verification Whether the product requires adult certification. In order to purchase a product that requires adult certification, you must go through personal certification. This cannot be used on Cafe24 Vietnam, Philippines. T: Used DEFAULT F |
| exposure_ | types of customers allowed to view the relevant product A: display to all DEFAULT A |
| exposure_ | customer tiers allowed to view the relevant product |
Update a bundle
PUT /api/v2/admin/bundleproducts/{product_no}
PUT
You can modify the information for a specific set product.
You can modify the product name, product information of the set product, set discount information, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| product_ Max Length : [250] | Product name Name of product. |
| bundle_ | composite product information |
| product_no purchase_quantity | |
| bundle_ | bundle discount information |
| discount_value discount_type discount_round_unit discount_round_type | |
| display | Whether display You can choose product should be displayed or not. T: Display |
| product_ | Product condition N: New |
| product_ Max : [2147483647] | Months of using the used product Used month for the product when product_condition is used product. |
| add_ | Category no Enter a category number to add a specific product category to the product |
| category_no recommend new | |
| delete_ | Deleted classification number Enter a category number to delete a specific product category to the product |
| custom_ Max Length : [40] | Custom product code You may assign this code manually in case of stock management or other reasons. |
| eng_ Max Length : [250] | English name of product Name of product in english. |
| supply_ Max Length : [250] | Supplier product name |
| internal_ Max Length : [50] | internal product name |
| model_ Max Length : [100] | Model name Model name of product. |
| use_ | whether use Naver Pay This cannot be used on Cafe24 Vietnam, Philippines. T: Used |
| naverpay_ | Naver Pay sales type This cannot be used on Cafe24 Vietnam, Philippines. C : Naver Pay + Shopping Mall Products at the same time |
| product_ Min : [0]~Max : [999999.99] | Weight of product |
| description | Detail description of product Detailed description of product. |
| mobile_ | 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_ Max Length : [255] | Product Summary Description Summary description of product. |
| simple_ | Simple Product Description Simple description of product. |
| product_ Array Max : [50] | Product tag Tag for search product. |
| payment_ | Payment info Payment method guidance. |
| shipping_ | Shipping info Shipping method guidance. |
| exchange_ | Exchange info Exchange/return method guidance. |
| service_ | Service info Service query / information guidance. |
| icon Array Max : [5] | List of icon Register icon. |
| use_ | whether use show date T: Used |
| icon_ | start date of show_date |
| icon_ | 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_ | Shipping information Shows whether can only deliver domestically or can deliver to overseas too. This cannot be used on Cafe24 Vietnam, Philippines. A: Domestic only |
| prepaid_ | Whether prepaid shipping fee This cannot be used on Cafe24 Vietnam, Philippines. C: Pay after delivery |
| shipping_ | Shipping method Shipping method(when shipping individually). 01: regular delivery |
| shipping_ | Shipping fee by product Shipping charge individually. T: Individual delivery |
| shipping_ Max Length : [255] | Shipping area Shipping area. |
| shipping_ Array Max : [2] | Shipping period Transit time. |
| minimum maximum | |
| shipping_ | 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_ | Shipping rates If shipping_fee_type is R or N, you can set the shipping cost by defining shipping_fee in the array. |
| clearance_ Type : [A-Z0-9] | Clearance category code Required if shipping information (shipping_scope) is B (domestic / overseas shipping) or C (overseas shipping) |
| detail_ | Detail image Detail image. |
| list_ | List image List image. |
| tiny_ | Tiny list image height Reduced image. |
| small_ | Reduced image Small list image. |
| image_ | Image type Image type. A: Register a representative image. |
| additional_ | Additional information list Additional item. |
| key value | |
| price_ Max Length : [20] | Alternative phrase of the selling price |
| buy_ | whether purchase restriction individual setting T: use |
| buy_ | Purchase limitation N: Purchase is only available to customer accounts + Buy button is hidden |
| buy_ | customer tiers allowed to purchase the relevant product |
| buy_ | Authorized customer ID |
| repurchase_ | repurchase restriction T : restrict repurchase |
| single_ | single purchase restriction T : restrict single purchase |
| points_ | whether use mileage individual setting F : use default setting |
| points_ | mileage individual setting - lower level item > basic setting mileage or mileage setting according to payment method B : Use the default reserve setting |
| points_ | Mileage setting |
| except_ | Mileage exception T : exclude 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_ 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 interrelated | |
| product_ | 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_ | 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 of product In case cloth products using a Japanese courier service, material information may required for some shipping companies. woven: Woven |
| additional_ | 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. |
| adult_ | Age verification Whether the product requires adult certification. In order to purchase a product that requires adult certification, you must go through personal certification. This cannot be used on Cafe24 Vietnam, Philippines. T: Used |
| exposure_ | types of customers allowed to view the relevant product A: display to all |
| exposure_ | customer tiers allowed to view the relevant product |
Delete a bundle
DELETE /api/v2/admin/bundleproducts/{product_no}
DELETE
You can delete a specific set product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ 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_ | Shop Number |
| product_ | Product number System assigned code. This code cannot be duplicated. |
| sequence_ | display order |
| auto_ | whether to use automatic sorting |
| sold_ | Whether sold out or stock is available |
| fixed_ | whether fixed |
| not_ | whether not for sale |
| display_ Min : [1]~Max : [3] | detailed product category 1 : Regular 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
You can view a list of products assigned to a specific category.
Product can be assigned to multiple categories at the same time.
You can check the product number, display order, sales status, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| category_ Required | Category number |
| display_ Required Min : [1]~Max : [3] | detailed product category 1 : Regular 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
You can view the number of products assigned to a specific category.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| category_ Required | Category number |
| display_ Required Min : [1]~Max : [3] | detailed product category 1 : Regular product |
Add products to a category
POST /api/v2/admin/categories/{category_no}/products
POST
You can assign products to specific categories.
Product can be assigned to multiple categories at the same time.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| category_ Required | Category number |
| display_ Min : [1]~Max : [3] | detailed product category 1 : Regular product DEFAULT 1 |
| product_ Required | Product number |
Update a product in product category
PUT /api/v2/admin/categories/{category_no}/products
PUT
You can modify the product assigned to a specific category.
It does not modify the product itself, but you can modify the settings for sorting and fixing.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| category_ Required | Category number |
| display_ Required Min : [1]~Max : [3] | detailed product category 1 : Regular product |
| product_ Required | Product number |
| sequence Min : [1]~Max : [999999] | Display order |
| auto_ | whether to use automatic sorting T : Use automatic arrangement |
| fixed_ | whether fixed T : Use designated display order |
Delete a product by category
DELETE /api/v2/admin/categories/{category_no}/products/{product_no}
DELETE
You can delete products assigned to a specific category.
The product is only deleted from the category, and the product itself is not actually deleted.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| category_ Required | Category number |
| product_ Required | Product number |
| display_ 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 DEFAULT 1 |
Mains products
A relational resource to the Mains resource about main category products’ display order.
Retrieve a list of products in main category
GET /api/v2/admin/mains/{display_group}/products
GET
You can check the list of products assigned to a specific main classification.
You can check the product number, product name, fixed status, etc.
Product can be assigned to multiple main categories at the same time.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| display_ Required | main category number |
Retrieve a count of products in main category
GET /api/v2/admin/mains/{display_group}/products/count
GET
You can inquire the number of products assigned to a specific main classification.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| display_ Required | main category number |
Set main category products
POST /api/v2/admin/mains/{display_group}/products
POST
You can assign products to specific main categories.
Product can be assigned to multiple categories at the same time.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| display_ Required | main category number |
| product_ Required | Product number |
Update fixed sorting of products in main category
PUT /api/v2/admin/mains/{display_group}/products
PUT
You can modify the product assigned to a specific main classification.
We do not modify the product itself, but we can modify the settings for fixing the display order.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| display_ Required | main category number |
| product_ Required | Product number Rank of product display will designated for requested order. |
| fix_ | 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
You can delete products assigned to a specific main classification.
This product is only deleted from the main classification, and the product itself is not actually deleted.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| display_ Required | main category number |
| product_ Required | Product number |
Products properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| product_ | Product number System assigned code. This code cannot be duplicated. |
| product_ Type : [A-Z0-9] | Product code System assigned code. This code cannot be duplicated. |
| custom_ Max Length : [40] | Custom product code You may assign this code manually in case of stock management or other reasons. |
| product_ 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_ Max Length : [250] | English name of product English name of product. Necessary when shipping to abroad. |
| supply_ 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_ Max Length : [50] | internal product name |
| model_ Max Length : [100] | Model name Model name of product |
| price_ | product price (before VAT) |
| price | Product price Selling price. Price that before applying coupon or other benefits. |
| retail_ | 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_ | 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 |
| 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". T: Sell |
| product_ | Product condition Displays condition of product N: New |
| product_ Max : [2147483647] | Months of using the used product |
| summary_ Max Length : [255] | Product Summary Description Summary description of product. Can Exposed at product display screen. You may input description with HTML. |
| product_ Array Max : [50] | Product tag Search tags. |
| margin_ 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_ | Tax calculation type A: Auto M: Manual |
| tax_ | Taxation category Tax type information of product. A: Taxable goods |
| tax_ Min : [0]~Max : [100] | Tax rate |
| price_ 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_ | whether purchase restriction individual setting T: use |
| buy_ | Purchase limitation Limit purchase as below information. N: Purchase is only available to customer accounts + Buy button is hidden |
| buy_ | customer tiers allowed to purchase the relevant product |
| buy_ | Authorized customer ID |
| repurchase_ | repurchase restriction T : restrict repurchase |
| single_ | single purchase restriction T : restrict single purchase |
| buy_ | 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 |
| buy_ | Minimum unit per purchase Minimum unit per purchase. |
| order_ | 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 |
| minimum_ Max : [2147483647] | Minimum quantity per purchase Minimum quantity per purchase. Customer cannot buy the product below the minimum quantity. |
| maximum_ Max : [2147483647] | Maximum quantity per purchase Maximum quantity per purchase. Customer cannot buy the product above the maximum quantity. |
| points_ | individual settings for points F : use default setting |
| points_ | points settings by payment method B : Use the default reserve setting |
| points_ | points settings information |
| except_ | omit additional points issued based on customer tiers T : exclude setting an additional mileage accumulation for member group |
| product_ | product volume information |
| adult_ | Age verification Whether the product requires adult certification. Customer needs to be authenticated to purchase products that require adult certification. T: Used |
| detail_ | Detail image Detail image' showing on the product detail page. |
| list_ | List image List image' showing on the product category page, main page, product search result page. |
| tiny_ | Tiny list image height Small list image' showing on the recently viewed page. |
| small_ | Reduced image Reduced image' showing on the bottom side of the product detail page. |
| use_ | whether use Naver Pay T: Used |
| naverpay_ | Naver Pay sales type C : Naver Pay + Shopping Mall Products at the same time |
| manufacturer_ Type : [A-Z0-9] | Manufacturer code Code uses for designate specific manufacturer. This code generated automatically when register a new manufacturer. |
| trend_ Type : [A-Z0-9] | Trend code Code uses for designate specific trend. This code generated automatically when register a new trend. |
| brand_ Type : [A-Z0-9] | Brand code Code uses for designate specific brand. This code generated automatically when register a new brand. |
| supplier_ Type : [A-Z0-9] | Supplier code Code uses for designate specific supplier. This code generated automatically when register a new supplier. |
| made_ | Date of manufacture Date of manufacture of the product. |
| release_ | Date of release Date of release of the product. |
| expiration_ 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_ | Origin classification Distinguish the origin of a product. F: domestic |
| origin_ | Origin place no List the origin number List all Origin by API |
| origin_ Max Length : [30] | Extra information for code of origin You may add additional information if 'origin_place_code' is 1800. |
| made_ | Origin country code |
| icon_ | 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. |
| product_ | Weight of product Weight of whole product. Total weight including product, box, and packing weight is necessary for shipping. |
| product_ | 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_ timezone | Created date Date when product registered. |
| updated_ timezone | Updated date Date when product modified. |
| english_ | 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 of product In case cloth products using a Japanese courier service, material information may required for some shipping companies. woven: Woven |
| list_ | Recommend / sold out / new icon expose flag Either showing recommend / sold out / new icon will be exposed or not. |
| approve_ | Approve request result N: New request for approval |
| classification_ Type : [A-Z0-9] | Classification code Custom classification code for the purpost of self-classification. |
| sold_ | Whether sold out or stock is available T: Out-of-stock |
| additional_ | Additional amount of the selling price |
| discountprice | Product discount sale price Resource
|
| decorationimages | Decoration Image Resource
|
| benefits | Benefits Resource
|
| options | Product Option Resource
|
| variants | Variants Resource
|
| clearance_ | English name of product Product classification information to use for the purpose of overseas customs clearance. |
| clearance_ | Korean product category for overseas customs clearance Product name as Korean |
| clearance_ Type : [A-Z0-9] | Clearance category code |
| additionalimages | additional image resource
|
| exposure_ | types of customers allowed to view the relevant product A: display to all |
| exposure_ | customer tiers allowed to view the relevant product |
| set_ | Product bundle type C: integral type. S: assembled type |
| use_ | Whether to use Kakao Pay T: Used |
| shipping_ | Shipping fee by product Set whether shipping fee will be charged separately or commonly. T: Used |
| shipping_ | 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
|
| hits | Product hits Resource
|
| seo | Product Seo Resource
|
| category | Category number Category of the product. Product is marked with this category. |
| project_ | planned exhibition number |
| description | Detail description of product Detail description of product. You may input description with HTML. |
| mobile_ | 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_ | add mobile version T: add mobile version product details |
| translated_ | Translation information of product details |
| payment_ | Payment info Guidance for payment method. You may input this with HTML. |
| shipping_ | Shipping info Guidance for shipping method. You may input this with HTML. |
| exchange_ | Exchange info Guidance for exchange and return method. You may input this with HTML. |
| service_ | Service info Guidance for service warranty information. You may input this with HTML. |
| product_ | Vat tax info Displays text set at VAT text setting menu. |
| country_ | HS code by country HS code used for customs duties when shipped overseas. You must enter the correct number for international shipment clearance. |
| simple_ | Simple Product Description Simple description of product. Can Exposed at product display screen. You may input description with HTML. |
| tags | Product Tag Resource
|
| has_ | 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 |
| option_ | Type of option Shows type of option when "has_option" is TRUE. C: Combination integration option |
| shipping_ | Shipping calculation type A: Auto M: Manual |
| shipping_ | Shipping method Following is the method when 'individual_delivery' is TRUE 01: regular delivery |
| prepaid_ | Whether prepaid shipping fee Returns null if shipping_calculation is A (autocomputation). C: Pay after delivery |
| shipping_ | Shipping period (When using 'Shipping charge individually') Average transit time for make a delivery. |
| shipping_ | Shipping information Shows whether can only deliver domestically or can deliver to overseas too. A: Domestic only |
| shipping_ Max Length : [255] | Shipping area (When using 'Shipping charge individually') Available shipping region. |
| shipping_ | 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. |
| origin_ | Code of origin Code of origin |
| additional_ | Additional information list You may add additional information other than basic information. |
| image_ | Image type Image type when uploading image. A: Register a representative image. |
| relational_ Array Max : [200] | Related product Related or similar product of selected product. Registered related product display the bottom of the product detail page. |
| select_ | 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. T: Use |
| translated_ | Translated additional description |
| additional_ 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. |
Retrieve a list of products
GET /api/v2/admin/products
GET
You can check the list of products created in the shopping mall.
You can check the product code, product name, price, etc.
If there are more than 5,000 products, you can't look it up with offset, so you can look it up if you use the sin_product_no parameter.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| discountprice embed | Product discount sale price Resource |
| decorationimages embed | Decoration Image Resource |
| benefits embed | Benefits Resource |
| options embed | Product Option Resource |
| variants embed | Variants Resource Up to 100 variants can be retrieved per product. |
| additionalimages embed | additional image resource |
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ | 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_ | 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_ | 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_ | Brand code Search for products with matching brand codes. You can search multiple item with ,(comma) |
| manufacturer_ | Manufacturer code Search for products with matching manufacturer code. You can search multiple item with ,(comma) |
| supplier_ | Supplier code Search for products with matching supplier code. You can search multiple item with ,(comma) |
| trend_ | Trend code Search for products with matching trend code. You can search multiple item with ,(comma) |
| product_ | 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_ | 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_ | Custom variants code You can search multiple item with ,(comma) |
| price_ | Minimum price Search for products that price is over a certain range. |
| price_ | Maximum price Search for products that price is below a certain range. |
| retail_ Min : [0] | Minimum retail price Search for products that retail price is over a certain range. |
| retail_ Min : [0] | Maximim retail price Search for products that retail price is below a certain range. |
| supply_ | Minimum supply price Search for products that supply price is over a certain range. |
| supply_ | Maximum supply price Search for products that supply price is below a certain range. |
| created_ 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_ 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_ 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_ 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_ | 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_ | 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_ | internal product name You can search multiple item with ,(comma) |
| model_ | 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_ | Product condition Search for products of specific condition. You can search multiple item with ,(comma) |
| origin_ | 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_ | Maximum stock search Search for items that product stock is below a certain value. |
| stock_ | Minimum stock search Search for variants that product stock is above a certain value. |
| stock_ | Search of maximum safety inventory quantity |
| stock_ | Search of minimum safety inventory quantity |
| product_ | Weight of product Search for items that weigh certain kilograms. You can search multiple item with ,(comma) |
| classification_ | Classification code You can search multiple item with ,(comma) |
| use_ | whether use inventory Whether use inventory management or not at the variants of the products. T: Use |
| category_ | Unapplied Category Search for products that category unapplied. T : Search for products that category unapplied |
| include_ | include sub category Search for products that include sub category. T: Included |
| additional_ | additional information key Search for products that has specific additional information. In order to search, key and value is necessary. |
| additional_ | additional information value Search for products that has specific additional information. In order to search, key and value is necessary. |
| approve_ | Approval Status N: Approval request (New product) status |
| since_ Min : [0] | Search after a certain product number Search products from after a certain product number. Can search regardless of offset. |
| product_ | Product bundle T: Use |
| sort | Sort order created_date: Created Date |
| order | Order by asc: Ascending |
| 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. DEFAULT 10 |
Retrieve a count of products
GET /api/v2/admin/products/count
GET
You can check the total number of products registered in the shopping mall.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ | 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_ | 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_ | Product code System assigned code. This code cannot be duplicated. You can search multiple item with ,(comma) |
| brand_ | Brand code Search for products with matching brand codes. You can search multiple item with ,(comma) |
| manufacturer_ | Manufacturer code Search for products with matching manufacturer code. You can search multiple item with ,(comma) |
| supplier_ | Supplier code Search for products with matching supplier code. You can search multiple item with ,(comma) |
| trend_ | Trend code Search for products with matching trend code. You can search multiple item with ,(comma) |
| product_ | 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_ | 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_ | Custom variants code You can search multiple item with ,(comma) |
| price_ | Minimum price Search for products that price is over a certain range. |
| price_ | Maximum price Search for products that price is below a certain range. |
| retail_ Min : [0] | Minimum retail price Search for products that retail price is over a certain range. |
| retail_ Min : [0] | Maximim retail price Search for products that retail price is below a certain range. |
| supply_ | Minimum supply price Search for products that supply price is over a certain range. |
| supply_ | Maximum supply price Search for products that supply price is below a certain range. |
| created_ 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_ 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_ 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_ 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_ | 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_ | 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_ | internal product name You can search multiple item with ,(comma) |
| model_ | 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_ | Product condition Search for products of specific condition. You can search multiple item with ,(comma) |
| origin_ | 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_ | Maximum stock search Search for items that product stock is below a certain value. |
| stock_ | Minimum stock search Search for variants that product stock is above a certain value. |
| stock_ | Search of maximum safety inventory quantity |
| stock_ | Search of minimum safety inventory quantity |
| product_ | Weight of product Search for items that weigh certain kilograms. You can search multiple item with ,(comma) |
| classification_ | Classification code Search for products with matching custom classification code. You can search multiple item with ,(comma) |
| use_ | whether use inventory Whether use inventory management or not at the variants of the products. T: Use |
| category_ | Unapplied Category Search for products that category unapplied. T : Search for products that category unapplied |
| include_ | include sub category Search for products that include sub category. T: Included |
| additional_ | additional information key Search for products that has specific additional information. In order to search, key and value is necessary. |
| additional_ | additional information value Search for products that has specific additional information. In order to search, key and value is necessary. |
| approve_ | Approval Status N: Approval request (New product) status |
| since_ Min : [0] | Search after a certain product number Search products from after a certain product number. Can search regardless of offset. |
| product_ | Product bundle T: Use |
Retrieve a product resource
GET /api/v2/admin/products/{product_no}
GET
You can look up the products created in the shopping mall.
You can check the product code, your own product code, product name, product price, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number Number of a product. |
| variants embed | Variants Resource |
| memos embed | Memos Resource |
| hits embed | Product hits Resource |
| seo embed | Product Seo Resource |
| tags embed | Product Tag Resource |
| options embed | Product Option Resource |
| discountprice embed | Product discount sale price Resource |
| decorationimages embed | Decoration Image Resource |
| benefits embed | Benefits Resource |
| additionalimages embed | additional image resource |
Create a product
POST /api/v2/admin/products
POST
You can register the product at the shopping mall.
You can also register options while registering the product.
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 DEFAULT F |
| selling | whether selling Whether selling or not. T: Sell DEFAULT F |
| product_ | Product condition N: New DEFAULT N |
| product_ Max : [2147483647] | Months of using the used product Used month for the product when product_condition is used product. |
| add_ | Category no Register your product in the category you want to display using the category number |
| category_no recommend new | |
| custom_ Max Length : [40] | Custom product code You may assign this code manually in case of stock management or other reasons. |
| product_ Required Max Length : [250] | Product name Name of product. |
| eng_ Max Length : [250] | English name of product Name of product in english. |
| supply_ Max Length : [250] | Supplier product name |
| internal_ Max Length : [50] | internal product name |
| model_ Max Length : [100] | Model name Model name of product. |
| price_ 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_ Min : [0]~Max : [2147483647] | Product retail price |
| supply_ 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_ | Whether the option is used Has an option or not. T: use option DEFAULT F |
| options | Option |
| name value | |
| use_ | whether use Naver Pay This cannot be used on Cafe24 Vietnam, Philippines. T: Used |
| naverpay_ | Naver Pay sales type This cannot be used on Cafe24 Vietnam, Philippines. C : Naver Pay + Shopping Mall Products at the same time |
| manufacturer_ Type : [A-Z0-9] | Manufacturer code Manufacturer code. DEFAULT M0000000 |
| trend_ Type : [A-Z0-9] | Trend code DEFAULT T0000000 |
| brand_ Type : [A-Z0-9] | Brand code DEFAULT B0000000 |
| supplier_ Type : [A-Z0-9] | Supplier code shipping_fee: shipping DEFAULT S0000000 |
| product_ Min : [0]~Max : [999999.99] | Weight of product |
| made_ | Date of manufacture |
| release_ | Date of release |
| expiration_ Array Max : [2] | Expiration date Expiration date. |
| start_date end_date | |
| description | Detail description of product Detailed description of product. |
| mobile_ | 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_ Max Length : [255] | Product Summary Description shipping_rates_max: Shipping interval end |
| simple_ | 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_ | Translation information of product details |
| product_ Array Max : [50] | Product tag Tag for search product. |
| payment_ | Payment info Payment method guidance. |
| shipping_ | Shipping info Shipping method guidance. |
| exchange_ | Exchange info Exchange/return method guidance. |
| service_ | 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) |
| country_ Array Max : [29] | HS code by country |
| shipping_ | Shipping information Shows whether can only deliver domestically or can deliver to overseas too. This cannot be used on Cafe24 Vietnam, Philippines. A: Domestic only |
| shipping_ | Shipping method Shipping method(when shipping individually). 01: regular delivery |
| shipping_ | Shipping fee by product Shipping charge individually. T: Individual delivery DEFAULT F |
| shipping_ Max Length : [255] | Shipping area Shipping area. |
| shipping_ Array Max : [2] | Shipping period Transit time. |
| minimum maximum | |
| shipping_ | 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_ 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. |
| shipping_rates_min shipping_rates_max shipping_fee | |
| prepaid_ | Whether prepaid shipping fee This cannot be used on Cafe24 Vietnam, Philippines. C: Pay after delivery |
| clearance_ Type : [A-Z0-9] | Clearance category code Required if shipping information (shipping_scope) is B (domestic / overseas shipping) or C (overseas shipping) |
| detail_ | Detail image Detail image. |
| list_ | List image List image. |
| tiny_ | Tiny list image height Reduced image. |
| small_ | Reduced image shipping_rates_min: Shipping interval start |
| image_ | Image type Image type. A: Register a representative image. DEFAULT A |
| additional_ | Additional information list Additional item. |
| key value | |
| price_ Max Length : [20] | Alternative phrase of the selling price |
| buy_ | whether purchase restriction individual setting T: use DEFAULT F |
| buy_ | Purchase limitation N: Purchase is only available to customer accounts + Buy button is hidden DEFAULT F |
| buy_ | customer tiers allowed to purchase the relevant product |
| buy_ | Authorized customer ID |
| repurchase_ | repurchase restriction T : restrict repurchase DEFAULT F |
| single_ | single purchase restriction T : restrict single purchase DEFAULT F |
| buy_ | 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 DEFAULT O |
| buy_ Max : [2147483647] | Minimum unit per purchase Unit of order. DEFAULT 1 |
| order_ | 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 DEFAULT O |
| minimum_ Max : [2147483647] | Minimum quantity per purchase Minimum quantity per purchase. Customer cannot buy the product below the minimum quantity. DEFAULT 1 |
| maximum_ Max : [2147483647] | Maximum quantity per purchase Maximum quantity per purchase. Customer cannot buy the product above the maximum quantity. DEFAULT 0 |
| points_ | individual settings for points F : use default setting DEFAULT F |
| points_ | points settings by payment method B : Use the default reserve setting |
| points_ | points settings information |
| payment_method points_rate points_unit_by_payment | |
| except_ | omit additional points issued based on customer tiers T : exclude setting an additional mileage accumulation for member group DEFAULT F |
| product_ | product volume information |
| use_product_volume product_width product_height product_length | |
| origin_ | Origin classification Distinguish the origin of a product. F: domestic |
| origin_ | Origin place no List the origin number Retrieve a list of origins by API |
| origin_ 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_ | Origin country code A two-digit country code for country of origin |
| main | whether display at main Displays main display number when display products at main page such as "recommend product" or "new". |
| relational_ 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 interrelated | |
| product_ | 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_ | 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 of product In case cloth products using a Japanese courier service, material information may required for some shipping companies. woven: Woven |
| classification_ Type : [A-Z0-9] | Classification code |
| additional_ 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_ 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_ | Taxation category Tax type information of product. A: Taxable goods |
| tax_ Min : [0]~Max : [100] | Tax rate |
| additional_ | 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. |
| adult_ | Age verification Whether the product requires adult certification. In order to purchase a product that requires adult certification, you must go through personal certification. This cannot be used on Cafe24 Vietnam, Philippines. T: Used DEFAULT F |
| exposure_ | types of customers allowed to view the relevant product A: display to all DEFAULT A |
| exposure_ | customer tiers allowed to view the relevant product |
| use_ | Whether to use Kakao Pay This cannot be used on Cafe24 Vietnam, Philippines. T: Used |
Update a product
PUT /api/v2/admin/products/{product_no}
PUT
You can modify the product created in the shopping mall.
You can modify display status, sales status, product name, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ 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 |
| selling | whether selling Whether selling or not. T: Sell |
| product_ | Product condition N: New |
| product_ Max : [2147483647] | Months of using the used product Used month for the product when product_condition is used product. |
| add_ | Category no Enter a category number to add a specific product category to the product |
| category_no recommend new | |
| delete_ | Deleted classification number Enter a category number to delete a specific product category to the product |
| custom_ Max Length : [40] | Custom product code You may assign this code manually in case of stock management or other reasons. |
| product_ Max Length : [250] | Product name Name of product. |
| eng_ Max Length : [250] | English name of product Name of product in english. |
| supply_ Max Length : [250] | Supplier product name |
| internal_ Max Length : [50] | internal product name |
| model_ Max Length : [100] | Model name Model name of product. |
| price_ 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_ Min : [0]~Max : [2147483647] | Product retail price |
| supply_ 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_ | Whether the option is used Has an option or not. F: Option not used |
| use_ | whether use Naver Pay This cannot be used on Cafe24 Vietnam, Philippines. T: Used |
| naverpay_ | Naver Pay sales type This cannot be used on Cafe24 Vietnam, Philippines. C : Naver Pay + Shopping Mall Products at the same time |
| manufacturer_ Type : [A-Z0-9] | Manufacturer code Manufacturer code. |
| trend_ Type : [A-Z0-9] | Trend code |
| brand_ Type : [A-Z0-9] | Brand code |
| supplier_ Type : [A-Z0-9] | Supplier code Supplier code. |
| product_ Min : [0]~Max : [999999.99] | Weight of product |
| made_ | Date of manufacture |
| release_ | Date of release |
| expiration_ Array Max : [2] | Expiration date Expiration date. |
| start_date end_date | |
| description | Detail description of product Detailed description of product. |
| mobile_ | 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_ | Translation information of product details |
| translated_ | Translated additional description |
| summary_ Max Length : [255] | Product Summary Description Summary description of product. |
| simple_ | Simple Product Description Simple description of product. |
| product_ Array Max : [50] | Product tag Tag for search product. |
| payment_ | Payment info Payment method guidance. |
| shipping_ | Shipping info Shipping method guidance. |
| exchange_ | Exchange info Exchange/return method guidance. |
| service_ | Service info Service query / information guidance. |
| icon Array Max : [5] | List of icon |
| use_ | whether use show date T: Used |
| icon_ | start date of show_date |
| icon_ | 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) |
| country_ Array Max : [29] | HS code by country |
| shipping_ | Shipping information Shows whether can only deliver domestically or can deliver to overseas too. This cannot be used on Cafe24 Vietnam, Philippines. A: Domestic only |
| shipping_ | Shipping method Shipping method(when shipping individually). 01: regular delivery |
| shipping_ | Shipping fee by product Shipping charge individually. T: Individual delivery |
| shipping_ Max Length : [255] | Shipping area Shipping area. |
| shipping_ | Shipping period Transit time. |
| minimum maximum | |
| shipping_ | 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_ 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. |
| shipping_rates_min shipping_rates_max shipping_fee | |
| prepaid_ | Whether prepaid shipping fee This cannot be used on Cafe24 Vietnam, Philippines. C: Pay after delivery |
| clearance_ Type : [A-Z0-9] | Clearance category code Required if shipping information (shipping_scope) is B (domestic / overseas shipping) or C (overseas shipping) |
| detail_ | Detail image Detail image. |
| list_ | List image List image. |
| tiny_ | Tiny list image height Reduced image. |
| small_ | Reduced image Small list image. |
| image_ | Image type Image type. A: Register a representative image. |
| additional_ | Additional information list Additional item. |
| key value | |
| price_ Max Length : [20] | Alternative phrase of the selling price |
| buy_ | whether purchase restriction individual setting T: use |
| buy_ | Purchase limitation N: Purchase is only available to customer accounts + Buy button is hidden |
| buy_ | customer tiers allowed to purchase the relevant product |
| buy_ | Authorized customer ID |
| repurchase_ | repurchase restriction T : restrict repurchase |
| single_ | single purchase restriction T : restrict single purchase |
| buy_ | 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 |
| buy_ Max : [2147483647] | Minimum unit per purchase Unit of order. |
| order_ | 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 |
| minimum_ Max : [2147483647] | Minimum quantity per purchase Minimum quantity for order. |
| maximum_ Max : [2147483647] | Maximum quantity per purchase Maximum quantity per purchase. Customer cannot buy the product above the maximum quantity. |
| points_ | individual settings for points F : use default setting |
| points_ | points settings by payment method B : Use the default reserve setting |
| points_ | points settings information |
| payment_method points_rate points_unit_by_payment | |
| except_ | omit additional points issued based on customer tiers T : exclude setting an additional mileage accumulation for member group |
| product_ | product volume information |
| use_product_volume product_width product_height product_length | |
| origin_ | Origin classification Distinguish the origin of a product. F: domestic |
| origin_ | Origin place no List the origin number List all Origin by API |
| origin_ 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_ | Origin country code A two-digit country code for country of origin |
| main | whether display at main Displays main display number when display products at main page such as "recommend product" or "new". |
| relational_ 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 interrelated | |
| product_ | 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_ | 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 of product In case cloth products using a Japanese courier service, material information may required for some shipping companies. woven: Woven |
| classification_ Type : [A-Z0-9] | Classification code |
| additional_ 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_ 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_ | Taxation category Tax type information of product. A: Taxable goods |
| tax_ Min : [0]~Max : [100] | Tax rate |
| additional_ | 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. |
| adult_ | Age verification Whether the product requires adult certification. In order to purchase a product that requires adult certification, you must go through personal certification. This cannot be used on Cafe24 Vietnam, Philippines. T: Used |
| exposure_ | types of customers allowed to view the relevant product A: display to all |
| exposure_ | customer tiers allowed to view the relevant product |
| use_ | Whether to use Kakao Pay This cannot be used on Cafe24 Vietnam, Philippines. T: Used |
Delete a product
DELETE /api/v2/admin/products/{product_no}
DELETE
You can delete the product created in the shopping mall.
When you delete a product, options (items) are also deleted at the bottom of the product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ 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
You can register additional images of the product.
When uploading an additional image, you can encode it into Base64 and upload it.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ Required | Product number |
| additional_ Required | Additional image ● Maximum number of requests: 20 |
Update an additional product image
PUT /api/v2/admin/products/{product_no}/additionalimages
PUT
You can modify additional images for that product.
When uploading an additional image, you can encode it into Base64 and upload it.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ Required | Product number |
| additional_ Required | Additional image ● Maximum number of requests: 20 |
Products approve
API which can only be used when mall using products approval function.
Products approve properties
| Attribute | Description |
|---|---|
| shop_ | 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 |
| product_ 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
You can check the approval status of the product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ 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
You can apply for approval for the product.
The product that has applied for approval is requested for approval in the status of approval request (new product).
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| user_ Required | Supplier operator ID ID of supplier operator who requested |
Update a product approval status
PUT /api/v2/admin/products/{product_no}/approve
PUT
You can change the approval status of the product.
If the representative manager approves the product, it can be updated with approval completion.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| user_ Required | Supplier operator ID ID of supplier operator who requested |
| status Required | Approval status Approval status of the product requested. C: Approved 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_ | Shop Number |
| use_ | whether use show date T: Use |
| show_ timezone | start date of show_date |
| show_ timezone | end date of show_date |
| image_ | list of decoration image Horizontal position (image_horizontal_position) |
Retrieve a list of product decoration images
GET /api/v2/admin/products/{product_no}/decorationimages
GET
Check the list of decorative images registered with a specific product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ 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
You can add a decorative image to your product.
When adding a decorative image, you can set the display period and the location of the decorative image.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number |
| use_ | whether use show date T: Use |
| show_ timezone | start date of show_date |
| show_ timezone | end date of show_date |
| image_ Required | list of decoration image Horizontal position (image_horizontal_position) |
| code path image_horizontal_position image_vertical_position | |
Update product decoration images
PUT /api/v2/admin/products/{product_no}/decorationimages
PUT
You can modify the decorative image of the product using the product number.
You can change whether the display period is used, the start date of the display period, and the end date.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| use_ | whether use show date T: Use |
| show_ timezone | start date of show_date |
| show_ timezone | end date of show_date |
| image_ Required | list of decoration image Horizontal position (image_horizontal_position) |
| code path image_horizontal_position image_vertical_position | |
Remove a product decoration image
DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}
DELETE
Delete the decorative image registered with the product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| code Required | code of decoration image |
| product_ 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.
Retrieve a product discounted price
GET /api/v2/admin/products/{product_no}/discountprice
GET
Check the discount price of the product using the product number.
You can check the discount price of your PC and mobile discount.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ Required | Product number |
Products hits
Product Views (Hits) is a measure of how much your products are viewed by your shopping mall customers. You can see how many products your customers are viewing most by checking product views.
Product views can only be used in the Products subset as a embedded Resource.
Retrieve a count of product views
GET /api/v2/admin/products/{product_no}/hits/count
GET
Check the number of views of the product using the product number.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ 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_ | Shop Number |
| use_ | whether use show date T: Use |
| show_ timezone | start date of show_date |
| show_ timezone | end date of show_date |
| image_ | list of product icon |
Set icons for a product
POST /api/v2/admin/products/{product_no}/icons
POST
You can register the product icon on the product.
Before registering an icon in the product, please check the code of the icon through List all icons.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ Required | Product number |
| image_ Required Array Max : [5] | list of product icon |
| code | |
Update product icons
PUT /api/v2/admin/products/{product_no}/icons
PUT
You can modify the product icon registered in the product.
You can change the display status and duration of the icon.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ Required | Product number |
| use_ | whether use show date T: Use |
| show_ timezone | start date of show_date |
| show_ timezone | end date of show_date |
| image_ Array Max : [5] | list of product icon |
| code | |
Remove a product icon
DELETE /api/v2/admin/products/{product_no}/icons/{code}
DELETE
You can delete (unregister) the product icon registered with the product.
The icon itself is not deleted and only the status registered with the product is released.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| product_ Required | Product number |
| 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_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| product_ | Product number System assigned code. This code cannot be duplicated. |
| detail_ | Detail image Detail image' showing on the product detail page. |
| list_ | List image List image' showing on the product category page, main page, product search result page. |
| tiny_ | Tiny list image height Small list image' showing on the recently viewed page. |
| small_ | Reduced image Reduced image' showing on the bottom side of the product detail page. |
Upload images
POST /api/v2/admin/products/images
POST
Allows you to upload an image.
To register an image on the product, you must upload the image first.
The image of the product can be encoded in Base64 code and uploaded
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 20 |
Request
| Parameter | Description |
|---|---|
| image Required | Detail image ● Maximum file size: 5MB |
Upload product images
POST /api/v2/admin/products/{product_no}/images
POST
You can register an image with the product.
You can register product details, lists, small lists, and thumbnail images.
Please check if the image is uploaded before registering it.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| detail_ | Detail image Detail image' showing on the product detail page. |
| list_ | List image List image' showing on the product category page, main page, product search result page. |
| tiny_ | Tiny list image height Reduced image' showing on the bottom side of the product detail page. |
| small_ | Reduced image Small list image' showing on the recently viewed page. |
| image_ 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. |
Delete product images
DELETE /api/v2/admin/products/{product_no}/images
DELETE
You can delete an image registered with the product.
All images registered in the product will be deleted regardless of the detailed image or list image.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ 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
You can look up notes registered with a specific product as a list.
You can inquire about the author's ID, creation date, and memo content.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| product_ 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. DEFAULT 10 |
Retrieve a product memo
GET /api/v2/admin/products/{product_no}/memos/{memo_no}
GET
You can inquire about one memo registered on a specific product.
You can inquire the author's ID, creation date, and memo content.
You need a memo number to check the memo. You can check the memo number through List all products memos.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| memo_ Required | Memo number System assigned code. This code cannot be duplicated. |
Create a product memo
POST /api/v2/admin/products/{product_no}/memos
POST
You can register notes for a particular product.
When you register a note, you must enter the ID of the memo author.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| author_ 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
You can modify the notes that are registered with a particular product.
When modifying a memo, you must enter the memo author's ID and memo number.
You can check the memo number through List all products memos.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| memo_ Required | Memo number System assigned code. This code cannot be duplicated. |
| author_ 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
You can delete a memo that is registered with a particular product.
You need a memo number to delete a memo. You can check the memo number through List all products memos.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| memo_ 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_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| has_ | Whether the option is used T: Use |
| option_ | Type of option Shows type of option when "has_option" is TRUE. T: Combination |
| option_ | Option list type If you use the combined option, show the type of the combined option C: Integrated type |
| option_ Type : [A-Z0-9] | Option set code If you use the linked with product option, show the option preset code. |
| options | Option |
| select_ | 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. T: Use |
| option_ | Option preset name If you use "linked with product" option, show the name of the option set |
| use_ | Whether use additional option T: Use |
| additional_ | Additional option |
| use_ | Whether use attached file option T: Use |
| attached_ | Attached file option |
Retrieve a list of product options
GET /api/v2/admin/products/{product_no}/options
GET
You can look up the product's options as a list.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
Create product options
POST /api/v2/admin/products/{product_no}/options
POST
You can create and register options for the product.
When you register an option, the item is automatically created.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| has_ | Whether the option is used T: Use |
| option_ | Type of option Enter type of option when "has_option" is TRUE. T: Combination |
| option_ | Option list type If you use the combined option, enter the type of the combined option S: Combination separation option |
| options | Option |
| option_name option_value Array option_text option_image_file option_color option_display_type | |
| select_ | 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. T: Used |
| option_ Type : [A-Z0-9] | Option set code |
| option_ | Option preset name If you use "linked with product" option, enter the name of the option set |
| use_ | Whether use additional option T: Use |
| additional_ | Additional option |
| additional_option_name additional_option_text_length required_additional_option | |
| use_ | Whether use attached file option T: Use |
| attached_ | Attached file option |
Update product options
PUT /api/v2/admin/products/{product_no}/options
PUT
You can modify the product's options.
You can only modify option names and option values, additional input options and file attachment options, and you cannot add or delete option items.
It also does not initialize the items that are created.
If you want to add or delete an option, you can delete it with the Delete a products option and register it again.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| option_ | Option list type If you use the combined option, enter the type of the combined option S: Combination separation option |
| option_ Type : [A-Z0-9] | Option set code If you use the linked with product option, enter the option preset code. |
| options | Option |
| option_name option_value Array option_text option_image_file option_link_image option_color option_display_type | |
| original_ | Option value before modification |
| option_name option_value Array option_text | |
| select_ | 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. T: Used |
| option_ | Option preset name If you use "linked with product" option, enter the name of the option set |
| use_ | Whether use additional option T: Use |
| additional_ | Additional option |
| additional_option_name additional_option_text_length required_additional_option | |
| use_ | Whether use attached file option T: Use |
| attached_ | Attached file option |
Delete a product option
DELETE /api/v2/admin/products/{product_no}/options
DELETE
You can delete the product's options.
If you delete an option, the option function will be 'Disabled' and the items that were previously created will be deleted as well, so you need to be careful.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
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_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| meta_ | Browser title Information displayed at product's detail page. Title tag is the most basic information for search which displays at browser. |
| meta_ | 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_ | Meta tag 2: Description Information displayed at tag in product detail page. You may input the information which displays at the search result. |
| meta_ | Meta tag 3: Keywords Information displayed at tag in product detail page. You may input keywords that want to be searched. |
| meta_ | 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_ | 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 |
Retrieve a product's SEO settings
GET /api/v2/admin/products/{product_no}/seo
GET
You can inquire the SEO settings of a specific product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
Update product SEO settings
PUT /api/v2/admin/products/{product_no}/seo
PUT
You can modify the SEO settings for a particular product.
You can modify browser titles, meta tags, search engine exposure settings, and more.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| meta_ | Browser title Information displayed at product's detail page. Title tag is the most basic information for search which displays at browser. |
| meta_ | 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_ | Meta tag 2: Description Information displayed at tag in product detail page. You may input the information which displays at the search result. |
| meta_ | Meta tag 3: Keywords Information displayed at tag in product detail page. You may input keywords that want to be searched. |
| meta_ | 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_ | 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.
Products tags properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| tags Required | Product tag |
| product_ | Product number System assigned code. This code cannot be duplicated. |
| tag | Product tag Tag or keyword for product searching. |
Retrieve a count of a product's product tags
GET /api/v2/admin/products/{product_no}/tags/count
GET
You can check the number of product tags registered on a particular product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ 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
You can look up tags registered in the product as a list.
You can check the product tag, product number, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
Create product tags
POST /api/v2/admin/products/{product_no}/tags
POST
You can register a product tag for searching or classifying specific products.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| tags Required Array Max : [50] | Product tag |
Delete a product tag
DELETE /api/v2/admin/products/{product_no}/tags/{tag}
DELETE
You can delete a specific tag that is registered with a specific product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ 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_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| variant_ Type : [A-Z0-9] | Product item code System assigned code. This code cannot be duplicated. |
| options | Option |
| custom_ 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 |
| 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 |
| additional_ | Additional price Additional price for purchase the variants. |
| use_ | whether use inventory T: Use |
| important_ | Whether it is an important inventory A: General inventory |
| inventory_ | Inventory check criteria A: Upon order |
| display_ | whether display sold-out T: Out-of-stock displayed |
| quantity | Available inventory |
| safety_ | minimum stock level |
| inventories | Inventories Resource Inventory Resource of variants. |
| duplicated_ | Whether duplicate custom variant code T: Duplicated |
| product_ | 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
You can look up the items of the product as a list.
You can check the product item code, display status, sales status, etc.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| inventories embed | Inventories Resource Inventory Resource of variants. You can search multiple item with ,(comma) |
Retrieve a product variant
GET /api/v2/admin/products/{product_no}/variants/{variant_code}
GET
You can look up specific items of the product.
You can inquire option information, your own item code, display and sales status.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| variant_ Required Type : [A-Z0-9] | Variant code |
| inventories embed | Inventories Resource |
Update a product variant
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT
You can modify certain items of the product.
You can modify your own item code, display status, sales status, and additional amount.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| variant_ Required Type : [A-Z0-9] | Product item code System assigned code. This code cannot be duplicated. |
| custom_ 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 |
| 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 |
| additional_ | Additional price Additional price for purchase the variants. |
| quantity | Available inventory |
| use_ | whether use inventory T: Use |
| important_ | Whether it is an important inventory A: General inventory |
| inventory_ | Inventory check criteria A: Upon order |
| display_ | whether display sold-out T: Out-of-stock displayed |
| safety_ | 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_ | Shop Number DEFAULT 1 |
| product_ Required | Product number |
| variant_ Required Type : [A-Z0-9] | Product item code |
| custom_ Max Length : [40] | Custom variants code |
| display | Whether display T: Display |
| selling | whether selling T: Sell |
| additional_ | Additional price |
| quantity | Available inventory |
| use_ | whether use inventory T: Use |
| important_ | Whether it is an important inventory A: General inventory |
| inventory_ | Inventory check criteria A: Upon order |
| display_ | whether display sold-out T: Out-of-stock displayed |
| safety_ | minimum stock level |
Delete a product variant
DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}
DELETE
You can delete certain items of the product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| variant_ Required Type : [A-Z0-9] | 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_ | Shop Number A unique number assigned to a store using the default store language or other languages |
| variant_ Type : [A-Z0-9] | Variant code System assigned code. This code cannot be duplicated. |
| use_ | 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 |
| important_ | 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 |
| inventory_ | Inventory check criteria Decide when the inventory will be deducted. You may set inventory deduction criteria differently. A: Upon order |
| display_ | 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. T: Out-of-stock 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_ | minimum stock level |
| origin_ | Shipping origin code |
Retrieve inventory details of a product variant
GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories
GET
You can check the inventory of items in the product.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_product |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| variant_ Required Type : [A-Z0-9] | 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
You can modify the information about the inventory of items in the product.
Inventory management can be used, important inventory, safety inventory can be set, and inventory quantity can be modified.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_product |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| product_ Required | Product number System assigned code. This code cannot be duplicated. |
| variant_ Required Type : [A-Z0-9] | Variant code System assigned code. This code cannot be duplicated. |
| use_ | 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 |
| important_ | 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 |
| inventory_ | Inventory check criteria Decide when the inventory will be deducted. You may set inventory deduction criteria differently. A: Upon order |
| display_ | 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. T: Out-of-stock 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_ | minimum stock level |
| origin_ | Shipping origin code |
Order
Cancellation
Cancellation is the ability to cancel certain orders before they are shipped.
It will be created after the seller receives it, and it will be processed through the cancellation processing process until the cancellation is completed.
Cancellation resources allow you to cancel multiple orders at once, modify or retrieve the cancellation status.
Unlike cancelling a specific order, it is not possible to cancel the PG.
Cancellation properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| order_ | Order ID |
| claim_ | Cancellation number |
| claim_ | division A: change of mind |
| claim_ | Reason |
| refund_ | Refund method |
| refund_ | Remarks |
| order_ | Purchase amount |
| refund_ | refund amount |
| shipping_ | shipping fee |
| return_ | Return shipping cost classification |
| defer_ | Postpayment Fee |
| partner_ | Affiliate discount cancellation amount |
| add_ | Extra discount discount by product |
| member_ | Membership Discount Discount Amount |
| shipping_ | Shipping discount cancellation amount |
| coupon_ | Coupon discount cancellation amount |
| point_ | Reimbursement Return Used |
| credit_ | Deposit Refund Used |
| undone | Undo T: Yes |
| undone_ | Reason for undoing A: change of mind |
| undone_ | Reason for undoing (Details) |
| expose_ | display reason in order details T: yes |
| exposed_ | Reason for undoing (Storefront) |
| items | Order item code |
| include_ | Include tax in prices T: Yes |
| tax | Tax information Return to null if tax manager app is disabled |
| status | Order status canceled: cancellation complete |
| recover_ | Inventory Recovery T : Recover |
| add_ | add to admin memo T: Enable |
Retrieve an order cancellation
GET /api/v2/admin/cancellation/{claim_code}
GET
You can inquire about the details of the cancellation completed or in progress.
You can check the refund method, refund amount, and reason for withdrawal.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_order |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| claim_ Required | Cancellation number |
Create multiple order cancellations
POST /api/v2/admin/cancellation
POST
You can cancel multiple orders before shipping.
If you cancel using the API, the refund is completed, but the PG is not canceled, and you have to cancel the PG separately.
In case of partial cancellation, each refund amount will be automatically calculated and refunded.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 100 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| status Required | Order status canceled: cancellation complete |
| recover_ | Inventory Recovery T : Recover DEFAULT F |
| recover_ | restore a coupon Unavailable for marketplace or NAVER Pay or KAKAOPAY order cancellations T : Recover DEFAULT F |
| recover_ | Coupon number to be recovered |
| add_ | add to admin memo Unavailable for marketplace or NAVER Pay or KAKAOPAY order cancellations T: Enable DEFAULT F |
| reason Max Length : [2000] | reason for cancellation |
| claim_ | type of reason for cancellation Unavailable for marketplace or NAVER Pay or KAKAOPAY order cancellations A: change of mind |
| naverpay_ | reason for NAVER Pay order cancellation Unavailable for Cafe24 store or marketplace or KAKAOPAY order cancellations This cannot be used on Cafe24 Vietnam, Philippines. 51 : change of mind |
| kakaopay_ | Reason for Kakaopay order cancellation Unavailable for marketplace or NAVER Pay order cancellations K1: Change of mind |
| refund_ | Refund method T : cash |
| combined_ | 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. T : cash |
| refund_ | code assigned to bank for refunds Required when refund method (refund_method) is set as cash (T) |
| refund_ Max Length : [250] | Bank name Required when refund method (refund_method) is set as cash (T) |
| refund_ | Refund account number Available only when refund method (refund_method) is set as cash (T) |
| refund_ Max Length : [15] | Refund Account Account Holder's Name |
| items | Order item code |
| order_item_code quantity | |
Change cancellation details in bulk
PUT /api/v2/admin/cancellation
PUT
You can modify the cancellation status of your order.
You can withdraw the status of an order for which a cancellation has been received to the status before the cancellation was received.
You can modify the cancellation status of the order to withdraw the cancellation, restore the inventory, or enter the reason for the withdrawal.
The courier already picked it upIf the request has been delivered, but no collection is required, contact the courier directly to collect itYou need 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_ Min : [1] | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| claim_ Required | Cancellation number |
| recover_ Required | Inventory Recovery T : Recover |
| undone Required | Undo T : 철회함 |
| add_ Required | add to admin memo T: Enable |
| undone_ Required | Reason for undoing A: change of mind |
| undone_ Max Length : [2000] | Reason for undoing (Details) |
| expose_ Required | display reason in order details T: yes |
| exposed_ Max Length : [2000] | Reason for undoing (Storefront) |
Cancellationrequests
Cancellation requests are functions related to cancellation requests for orders.
You can request cancellation or refuse to accept the order you are requesting cancellation.
Create a cancellation request for multiple items
POST /api/v2/admin/cancellationrequests
POST
You can request cancellation.
You can enter the account number to be refunded if it is the reason for cancellation and account refund.
You can request cancellation of several cases at the same time with ,(comma).
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 100 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| reason_ Required | type of reason for cancellation A: change of mind |
| reason Required Max Length : [2000] | reason for cancellation |
| refund_ | code assigned to bank for refunds Required when refund method (refund_method) is set as cash (T) |
| refund_ Max Length : [250] | Bank name |
| refund_ | Refund account number |
| refund_ Max Length : [15] | Refund Account Account Holder's Name |
| items | list of items |
| order_item_code quantity | |
Reject a cancellation request for multiple items
PUT /api/v2/admin/cancellationrequests
PUT
You can change the status of the cancellation request for a particular stock of the order requested to be canceled.
You can reject the application and enter the reason.
You can request cancellation of several cases at the same time with ,(comma).
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 100 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| order_ Required | Order item code |
| undone Required | Rejected to accept T: Yes |
| reason_ | type of reason A: change of mind |
| reason Max Length : [2000] | Reason |
| display_ | Display reason in [Storefront>My Orders] T: yes DEFAULT F |
| reject_ Max Length : [2000] | reason for rejection |
Cashreceipt
A cash receipt is a proof of payment that the buyer can receive after purchasing in cash.
Cash receipts resources allow you to issue or modify cash receipts and view cash receipts issued to date.
Cash receipts are only available in Korea and can only be used in Korean shopping malls.
Cashreceipt properties
| Attribute | Description |
|---|---|
| cashreceipt_ | Cash receipt number |
| approval_ | Approval Number |
| request_ | Date requested |
| order_ | Order ID |
| member_ | Member id |
| name | Requester |
| order_ | Purchase amount |
| vat | VAT |
| subtotal | Subtotal |
| order_ | Order status Awaiting payment: unpaid |
| status | status Requested: request |
| pg_ | Requested payment gateway |
| cash_ | Cash receipt serial number |
| type | Issuance type Individual: personal |
| company_ | Company registration number |
| cellphone | Mobile |
| tax_ | Tax amount |
| tax_ | Deductions |
| supply_ | 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_ Required timezone | Search Start Date |
| end_ Required timezone | Search End Date |
| order_ Order ID | Order ID You can search multiple item with ,(comma) |
| approval_ Max Length : [9] | Approval Number |
| name Max Length : [20] | Requester |
| member_ Max Length : [20] | Member id |
| status | status All: all 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_ Required Order ID | Order ID |
| type Required | Issuance type Individual: personal |
| company_ Business Number | Company registration number |
| cellphone Mobile | 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_ Required Min : [1] | Cash receipt number |
| order_ Required Order ID | Order ID |
| type | Issuance type Individual: personal |
| company_ Business Number | Company registration number |
| cellphone Mobile | Mobile |
Cashreceipt cancellation
Cash receipt cancellation is a function that allows you to cancel applications or cancel issuance for issued cash receipts.
Update a cash receipt cancellation
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation
PUT
You can cancel the application or cancel the issuance of the issued cash receipt.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| cashreceipt_ Required Min : [1] | Cash receipt number |
| order_ Required Order ID | Order ID |
| type Required | Cancellation type Cancel request: request |
Collectrequests
Collection requests are resources that can modify collection request information when requesting collection through return or exchange processing.
Update a collection request
PUT /api/v2/admin/collectrequests/{request_no}
PUT
Modify the collection application information using the collected invoice number.
Enter the request number and collection invoice number as required.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 30 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| request_ Required | Request number |
| collect_ Required Max Length : [30] | Collection tracking number |
Draftorders
Draftorders is a feature that allows you to process order reservations.
You can check order information such as order number and payment amount in advance through the temporary order.
Endpoints
Draftorders properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| order_ | 주문 번호 |
| payment_ | 가주문 가격 정보 |
| order_ | Mobile type T: Made on mobile DEFAULT F |
| payment_ Max Length : [10] | payment method code cash : deposit without a bankbook |
| items | Order item list |
Create a draft order
POST /api/v2/admin/draftorders
POST
Process order reservations.
Order reservation processing allows you to check order information such as order number and payment amount in advance before payment.
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_ Min : [1] | Shop Number DEFAULT 1 |
| member_ Max Length : [20] | Member id |
| order_ | Mobile type T: Mobile order DEFAULT F |
| payment_ Max Length : [10] | payment method code cash: bank deposit |
| order_ Type : [a-zA-Z0-9_-] | order channel self: PC store (for Cafe24 orders only) |
| country_ | Country code |
| payment_ Max Length : [20] | PG name |
| receiver_ Required Max Length : [100] | Receiver name |
| receiver_ Max Length : [100] | Receiver name (English) |
| receiver_ Max Length : [100] | Receiver name (Pronunciation) |
| receiver_ Required | Receiver phone number |
| receiver_ Required | Receiver mobile phone number |
| receiver_ Length Min : [2]~Max : [14] | Receiver zip code |
| receiver_ | Recipient address 1 |
| receiver_ | Recipient address 2 |
| receiver_ | city |
| receiver_ | state/region |
| shipping_ | Shipping message |
| buyer_ Required Max Length : [100] | Orderer name |
| buyer_ | Buyer Email |
| buyer_ | Buyer phone number |
| buyer_ | Buyer mobile number |
| buyer_ Required Length Min : [2]~Max : [14] | Orderer zip code |
| buyer_ Required Max Length : [250] | Customer address 1 |
| buyer_ Required | Customer address 2 |
| no_ | Shipping address doesn't exist T: No DEFAULT F |
| buyer_ IP | Orderer IP |
| transaction_ Max Length : [100] | Card transaction ID |
| bank_ Type : [a-z0-9_-] | Bank code |
| bank_ Max Length : [30] | Bank account no |
| bank_ Max Length : [100] | Bank account holder number |
| shipping_ | Delivery type A: Domestic |
| send_ | Whether to send a new order guide message T: send SMS DEFAULT F |
| send_ | Whether to send a deposit guide message T: send SMS DEFAULT F |
| send_ | Whether to send a new order guide mail T: send SMS DEFAULT F |
| clearance_ | customs clearance information I: ID |
| clearance_ | customs clearance information |
| self_ | allowed to cancel with API T: yes DEFAULT F |
| self_ | cancel with API URL |
| items | Order item list |
| product_no product_code option_id quantity product_bundle prepaid_shipping_fee product_bundle_no | |
Exchange
Accept exchange request & update exchange status of an order
Exchange properties
| Attribute | Description |
|---|---|
| shop_ | Shop Number |
| order_ | Order ID |
| claim_ | Return number |
| claim_ | division A: change of mind |
| claim_ | Reason |
| claim_ | Estimated exchange date |
| receiver | Receiver |
| reshipping_ | reshipping details |
| pickup | Pickup - Address |
| additional_ | Additional payment |
| return_ | return tracking number |
| return_ | return shipping carrier |
| refund_ | Refund method |
| refund_ | Remarks |
| order_ | Purchase amount |
| refund_ | refund amount |
| shipping_ | shipping fee |
| return_ | Return shipping cost classification |
| defer_ | Postpayment Fee |
| partner_ | Affiliate discount cancellation amount |
| add_ | Extra discount discount by product |
| member_ | Membership Discount Discount Amount |
| shipping_ | Shipping discount cancellation amount |
| coupon_ | Coupon discount cancellation amount |
| point_ | Reimbursement Return Used |
| credit_ | Deposit Refund Used |
| undone | Undo T: Yes |
| undone_ | Reason for undoing A: change of mind |
| undone_ | Reason for undoing (Details) |
| expose_ | display reason in order details T: yes |
| exposed_ | Reason for undoing (Storefront) |
| items | Order item code |
| exchanged_ | Exchanged items |
| include_ | Include tax in prices T: Yes |
| tax | Tax information Return to null if tax manager app is disabled |
| status | Order status accept: accept exchange request |
| recover_ | Inventory Recovery T : Recover |
| exchanged_ | exchange status after pickup T: Used |
| add_ | add to admin memo T: Enable |
| pickup_ | Whether pickup is complete T: Yes |
Retrieve an exchange
GET /api/v2/admin/exchange/{claim_code}
GET
Enter the exchange number to inquire about the order in which the exchange has been received.
You can check the order number, return number, reason, and scheduled exchange date.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_order |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| claim_ Required | Exchange number |
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_ Min : [1] | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| status Required | Order status accepted: Exchange request accepted |
| recover_ | Inventory Recovery T : Recover DEFAULT F |
| add_ | add to admin memo T: Enable DEFAULT F |
| items | Order item code |
| order_item_code quantity exchange_variant_code | |
| same_ Required | exchange status T: exchange for the same 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_ | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| claim_ Required | Exchange number |
| status | Order status exchanged: Exchanged |
| pickup_ | Whether pickup is complete T: Yes |
| recover_ | Inventory Recovery T : Recover |
| exchanged_ | exchange status after pickup T: Used |
| items | Order item code |
| order_item_code | |
| undone | Undo T : 철회함 |
| add_ | add to admin memo T: Enable |
| undone_ | Reason for undoing A: change of mind |
| undone_ Max Length : [2000] | Reason for undoing (Details) |
| expose_ | display reason in order details T: yes |
| exposed_ Max Length : [2000] | Reason for undoing (Storefront) |
Exchangerequests
Exchange requests are a function that allows you to request an exchange for an order.
Bulk exchange request API
POST /api/v2/admin/exchangerequests
POST
You can process exchange requests for specific orders.
You can request multiple exchanges at the same time with ,(comma).
You can register the reason for the exchange and whether or not to apply for collection.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 100 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| reason_ Required | type of reason A: Change of mind |
| reason Required Max Length : [2000] | Reason for exchange |
| request_ | request pickup T: Request pickup |
| pickup | pickup location details |
| name phone cellphone zipcode address1 address2 | |
| tracking_ Max Length : [30] | return tracking number |
| shipping_ Max Length : [30] | return shipping carrier |
| refund_ | code assigned to bank for refunds |
| refund_ Max Length : [250] | Bank name |
| refund_ | Refund account number |
| refund_ Max Length : [15] | Refund Account Account Holder's Name |
| items | list of items |
| order_item_code quantity | |
| exchange_ | Products for exchange |
| product_no variant_code quantity | |
Reject an exchange request for multiple items
PUT /api/v2/admin/exchangerequests
PUT
You can change the status of a requesting exchange for a specific stock of the order for which an exchange has been requested.
You can reject the application and enter the reason.
, (comma) allows you to change the status of several exchange requests at the same time.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 100 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| order_ Required | Order item code |
| undone Required | Rejected to accept T: Yes |
| reason_ | type of reason A: change of mind |
| reason Max Length : [2000] | Reason |
| display_ | Display reason in [Storefront>My Orders] T: yes DEFAULT F |
| reject_ Max Length : [2000] | reason for rejection |
Labels
Endpoints
Create multiple order labels
POST /api/v2/admin/labels
POST
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 10 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number DEFAULT 1 |
| name Required | Order label name |
| order_ Required | Order item code |
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_ | 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_ | Order ID |
| market_ | Market id Unique ID of a market for distinguish each website in case customer purchase through price comparison site. |
| market_ | Market order number |
| member_ | Member id |
| member_ | customer email |
| member_ | Member authentication Member authentication type. Customer divided as 4 types based on member authentication. T: authorized |
| billing_ | Billing name Name of billing. May differ from orderer name or recipient name. |
| bank_ | Bank code |
| bank_ | Bank name |
| payment_ | payment method code Code of payment method that orderer used for payment. cash : deposit without a bankbook |
| payment_ | Payment method name Name of payment method that orderer used for payment. |
| payment_ | Payment gateway name Name of payment gateway that orderer used for payment. |
| sub_ | International payment method name |
| sub_ | International payment method code |
| transaction_ | Card transaction ID |
| paid | Paid Whether or not the order was paid for T: Paid |
| canceled | Whether the order is canceled T: Canceled |
| order_ timezone | Ordered date |
| first_ | First order Whether the order is the first order from the customer or not. T: First order |
| payment_ timezone | Payment date |
| order_ | Mobile type whether order made on mobile T: Made on mobile |
| use_ | Whether to use Escrow whether customer used escrow or not T: Used escrow |
| group_ | Customer group number when ordering |
| initial_ | initial payment details |
| actual_ | final payment details Coupon_shipping_feee_amount of the actual payment amount is only exposed when using the automatic calculation of the discount amount because it can be distributed by item only when using the automatic calculation function of the discount amount is used |
| bank_ | Bank account no Bank account number of shooping mall of the specific order. |
| bank_ | Bank account holder number |
| market_ | marketplace vendor ID |
| payment_ | Order total |
| cancel_ timezone | Order cancellation date |
| order_ | Order path text |
| order_ | Available order path |
| payment_ | Whether payment is confirmed T: confirmed payment |
| commission | Transaction fee |
| postpay | Whether postpaid T: Payment after delivery |
| admin_ | manually input amount |
| additional_ | Additional shipping fee |
| international_ | International shipping insurance |
| additional_ | Additional handling fee |
| shipping_ | Delivery type Shipping delivery type. Whether domestic shipping or abroad shipping. A: Domestic |
| shipping_ | Delivery type Description of shipping type. Whether domestic shipping or abroad shipping. |
| shipping_ | Delivery status F: Awaiting shipment |
| wished_ | Desired delivery date |
| wished_ | Desired delivery time |
| wished_ | Desired courier code |
| wished_ | name of preferred shipping carrier |
| return_ timezone | Return approval time |
| total_ | Total supply price |
| naver_ | NAVER points |
| additional_ | Additional order info |
| store_ | Store pickup T: Store pickup |
| easypay_ | Easypay payment gateway name |
| loan_ | Loan status OK : GOOD |
| subscription | subscription payment T: subscription payment |
| items | Item Resource
|
| receivers | Receiver Resource
|
| buyer | Orderer Resource
|
| shipping_ | Shipping fee information |
| regional_ | Regional surcharge details |
| return | Return Details Resource
|
| cancellation | Cancellation details Resource
|
| exchange | Exchange details Resource
|
| multiple_ | Multi-address order T: Yes (Multi-address order) |
| exchange_ | Exchange rate |
| first_ | initial payment method code cash : deposit without a bankbook |
| naverpay_ | NaverPay PG payment information P: PG payment |
| include_ | Include tax in prices T: Yes |
| tax_ | Tax details |
| service_ | Order service type rental : rental order |
| service_ | order service data |
| customer_ | Customer group number when ordering Customer group number when order occurred. |
| benefits | Benefits Resource
|
| coupons | Coupon Resource
|
| refunds | refund details resource
|
| process_ | Order status prepare: preparing for shipment |
| order_ | Order item code |
| purchase_ | Whether the order was confirmed as received |
| collect_ | Whether points are recaptured |
Retrieve a list of orders
GET /api/v2/admin/orders
GET
You can look up your order as a list.
You can check the order number, currency unit, member ID, etc.
Sub-resources can be used as embedded to retrieve more information needed for a single call.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_order |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| items embed | Item Resource |
| receivers embed | Receiver Resource |
| buyer embed | Orderer Resource |
| return embed | Return Details Resource |
| cancellation embed | Cancellation details Resource |
| exchange embed | Exchange details Resource |
| shop_ Min : [1] | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| start_ timezone | Search Start Date start date for search |
| end_ timezone | Search End Date Search end date for specific search criteria. |
| order_ Order ID | Order ID You can search multiple item with ,(comma) |
| order_ | Order status Order status. Each status has its own code. You can search multiple item with ,(comma) N00: awaiting payment |
| payment_ | Payment status F: Awaiting payment |
| member_ | Member type Whether member or not. Each has its own code. 2: Member |
| group_ | Group number |
| buyer_ | Buyer name Name of orderer. May differ from billing name or recipient name. |
| receiver_ | Receiver name Name of recipient. May differ from orderer name or billing name. |
| name_ | Receiver name (Pronunciation) |
| receiver_ | Receiver address Address of recipient. May differ from orderer address or billing address. |
| member_ | Member id member id |
| member_ | customer email |
| product_ | Product number System assigned code. This code cannot be duplicated. |
| product_ | Product code System assigned code. This code cannot be duplicated. |
| date_ | Date type Date type for search. Default is date of order. order_date : Ordered date DEFAULT order_date |
| supplier_ | Supplier id You can search multiple item with ,(comma) |
| order_ | Available order path You can search multiple item with ,(comma) cafe24:Cafe24 |
| buyer_ | Buyer mobile number |
| buyer_ | Buyer phone number |
| buyer_ | Buyer Email |
| inflow_ | sales funnel |
| subscription | subscription payment T: subscription payment |
| market_ Type : [a-zA-Z0-9_-] | Market order number You can search multiple item with ,(comma) |
| market_ | marketplace order cancellation T: cancellation requested marketplace order |
| payment_ | payment method code You can search multiple item with ,(comma) cash : deposit without a bankbook |
| payment_ | Payment gateway name You can search multiple item with ,(comma) |
| market_ | marketplace vendor ID |
| discount_ | Discount method You can search multiple item with ,(comma) point: points |
| discount_ | Promo code |
| carrier_ Min : [1] | shipping carrier ID |
| labels | 주문 라벨 You can search multiple item with ,(comma) |
| limit Min : [1]~Max : [1000] | Limit Set the maximum number of search result. DEFAULT 10 |
| offset Max : [15000] | Start location of list DEFAULT 0 |
Retrieve an order
GET /api/v2/admin/orders/{order_id}
GET
You can inquire about 1 order.
You can check the order number, member ID, payment method, etc.
Sub-resources can be used as embedded to retrieve more information needed for a single call.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_order |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| order_ Required Order ID | Order ID |
| items embed | Item Resource |
| receivers embed | Receiver Resource |
| buyer embed | Orderer Resource |
| benefits embed | Benefits Resource |
| coupons embed | Coupon Resource |
| return embed | Return Details Resource |
| cancellation embed | Cancellation details Resource |
| exchange embed | Exchange details Resource |
| refunds embed | refund details resource |
Retrieve a count of orders
GET /api/v2/admin/orders/count
GET
You can retrieve the number of orders.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.read_order |
| Request Limit | 40 |
Request
| Parameter | Description |
|---|---|
| shop_ Min : [1] | Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1 |
| start_ timezone | Search Start Date Search start date for specific search criteria. |
| end_ timezone | Search End Date Search end date for searching orders. Must be used with a search start date. |
| order_ Order ID | Order ID You can search multiple item with ,(comma) |
| order_ | Order status Order status. Each status has its own code. You can search multiple item with ,(comma) N00: awaiting payment |
| payment_ | Payment status F: Awaiting payment |
| member_ | Member type Customer settings. Different codes are assigned to customers and guests. 2: Member |
| group_ | Group number |
| buyer_ | Buyer name Name of customer who orders the product. It may be different from the name of the depositor or the recipient. |
| receiver_ | Receiver name Name of the recipient. May differ from the address of the customer or the depositor |
| name_ | Receiver name (Pronunciation) |
| receiver_ | Receiver address Address of the recipient. May differ from the address of the customer or the depositor |
| member_ | Member id Customer ID |
| member_ | customer email |
| product_ | Product number Product number |
| product_ | Product code Search for products of which product codes include the search query that you enter. The search query is case-insensitive. |
| date_ | Date type Date filter type for search. The default value is date of order. order_date : Ordered date DEFAULT order_date |
| supplier_ | Supplier id You can search multiple item with ,(comma) |
| order_ | Available order path You can search multiple item with ,(comma) cafe24:Cafe24 |
| buyer_ | Buyer mobile number |
| buyer_ | Buyer phone number |
| buyer_ | Buyer Email |
| inflow_ | sales funnel |
| subscription | subscription payment T: subscription payment |
| market_ Type : [a-zA-Z0-9_-] | Market order number You can search multiple item with ,(comma) |
| market_ | marketplace order cancellation T: cancellation requested marketplace order |
| payment_ | payment method code You can search multiple item with ,(comma) cash : deposit without a bankbook |
| payment_ | Payment gateway name You can search multiple item with ,(comma) |
| market_ | marketplace vendor ID |
| discount_ | Discount method You can search multiple item with ,(comma) point: points |
| discount_ | Promo code |
| carrier_ Min : [1] | shipping carrier ID |
| labels | 주문 라벨 You can search multiple item with ,(comma) |
Update status for multiple orders
PUT /api/v2/admin/orders
PUT
You can modify the order status of multiple orders.
Please check the Order buyer and Order recipients to modify the buyer or recipient's information.
Please check the Orders shipments for the delivery of your order.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 100 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| process_ | Order status prepare: preparing for shipment |
| order_ | Order item code |
| purchase_ | Whether the order was confirmed as received T: Yes |
| collect_ | Whether points are recaptured T: Yes DEFAULT F |
Update an order status
PUT /api/v2/admin/orders/{order_id}
PUT
You can modify the status of one order.
Please check the Order buyer and Order recipients to modify the buyer or recipient's information.
Please check the Orders shipments for the delivery of your order.
Specification
| Property | Description |
|---|---|
| SCOPE | mall.write_order |
| Request Limit | 40 |
| objects per single API call Limit | 1 |
Request
| Parameter | Description |
|---|---|
| shop_ | Shop Number DEFAULT 1 |
| order_ Required | Order ID |
| process_ | Order status prepare: preparing for shipment |
| order_ | Order item code |
| purchase_ | Whether the order was confirmed as received T: Yes |
| collect_ | Whether points are recaptured T: Yes DEFAULT F |