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.

API Diagram

Check out the overall structure of Cafe24 API through the diagram that describes the relations between resources.

Request/Response Format

API request and response support JSON format.
For privacy protection purposes, Cafe 24 API only supports HTTPS protocol.
Dates properties are provided in the ISO_8601 format. : YYYY-MM-DDTHH:MM:SS + 09:00

Request Example (search)

Request Example (register/modify)

Right response example

{
    "resource": {
        "key": "value",
        "key": "value"
     }
}

Error response example

{
    "error": {
        "code": "error code",
        "message": "error message",
        "more_info": {
        }
    }
}

Method

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

POST : Create the resource.
GET: Read data the resource.
PUT : Modify(Update) the resource.
DELETE : Delete (delete) the resource.

Front API Intro

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

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

API Status Code

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

How to use GET API

Cafe24 API provides several ways to get the data.

The following describes the different ways to recall data using various parameters when inquiring an API.

1. Add search 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:00 

2. Use commas to search for more than one item

Use commas to search for data for more than one item. (You can search for up to 100 items in one query.)

The search conditions separated by commas are OR conditions; You can view all data corresponding to the conditions.

  Use commas to search for more than one item  
 E.g. When searching for products by specifying their product numbers
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13

E.g. When searching for products by specifying their product numbers and product codes
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13&product_code=P000000X,P000000W 

3. View multi-language store information

You can search for the information of a localized store by specifying its multi-language store number.

If you don't, the information of the default store will be shown.

  View multi-language store information  
 E.g. When searching for products in a certain localized store
GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2 

4. Retrieve single item & details

You can retrieve the details of a resource by specifying its ID.

You can only search for the details of one single product in one query

but you can retrieve more details than when you search for multiple products.

  Retrieve single item & details  
 E.g. When retrieving the details of a product by specifying its product number
GET https://{mallid}.cafe24api.com/api/v2/admin/products/128


E.g. When retrieving the details of one single product by specifying its product number
GET https://{mallid}.cafe24api.com/api/v2/admin/products?product_no=128 

5. Pagination

If there are too many results, you define the number of details returned in one response with the "limit" parameter.

If you are not able to view all details with the maximum value of the "limit" parameter, you can use the "offset" parameter.

  Pagination  
 E.g. When paging the details of 100 products at a time
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100


E.g. When retrieving details from the 201st to the 300th product
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100&offset=200 

6. Retrieve specific items

Use the "fields" parameter to view specific details

  Retrieve specific items  
 E.g. When retrieving the product name and product name only
GET https://{mallid}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no 

7. View sub-resources

If supported by the API you are using, you can search for the data for sub-resources with the "embed" parameter.

  View sub-resources  
 E.g. When searching for the variants and stock of a product
GET https://{mallid}.cafe24api.com/api/v2/admin/products/570?embed=variants,inventories 

API Limit

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

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

If the app calls the API twice a second, you can continue to use the API calls without restriction.
If more than "Request Limit" calls are generated momentarily within a second, return the 429 error (too many requests).
If more than 10 requests per second are made from the same IP address of an online store, the requests may be considered abnormal or malicious.

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

X-Api-Call-Limit : 1/40

Versioning

Past Versions are provided in date format to support APIs that are not compatible with (latest) 2024-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)

Product

Categories products

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

Endpoints

GET /api/v2/categories/{category_no}/products
GET /api/v2/categories/{category_no}/products/count

Categories products properties

Attribute	Description
shop_no	Shop Number
product_no	Product number System assigned code. This code cannot be duplicated.
product_name	Product name
manufacturer_name	Manufacturer
origin_place_value	origin
retail_price	Product retail price
price	Price
interest_free_period	interest-free installment payment period
eng_product_name	English name of product
custom_product_code	Custom product code
point_amount	Points
brand_name	Brand name
model_name	Model name
price_excluding_tax	Product price
tax	Tax amount
product_code	Product code
simple_description	Simple Product Description
summary_description	Product Summary Description
supplier_name	Supplier name
made_date	Date of manufacture
review_count	number of reviews
expiration_date	Expiration date
coupon_discounted_price	Coupon-discounted price
trend_name	Trend name
shipping_scope	Shipping information
shipping_fee_type	Shipping charge T: Free shipping R: Fixed rate M: Charge according to purchase amount D: Use different shipping charges per different purchase amount W: Use different shipping charges by product weight C: Use different shipping charges by quantity N: Use different shipping charges per different quantity
shipping_rates	Charge shipping by section
shipping_fee	shipping fee
discount_price	Discounted price
optimum_discount_price	Fully discounted price
shipping_method	Shipping method
promotion_period	Discount & sales schedule
color	Product color
translated_additional_description	Translated additional description
stock_quantity	Inventory quantity
question_count	number of product inquiries
product_article_count	number or product boards

Retrieve a list of products by category

GET /api/v2/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
mobile	whether a mobile setup value has been retrieved T: Use F: Do not use
shop_no	Shop Number DEFAULT 1
category_no Required	Category number
display_group Required Min : [1]~Max : [3]	detailed product category 1 : Regular product 2 : Recommend product 3 : New product
limit Min : [1]~Max : [200]	Limit DEFAULT 100
offset Max : [8000]	Start location of list DEFAULT 0

Request Copy

Response Copy

Retrieve a count of products by category

GET /api/v2/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_no	Shop Number DEFAULT 1
category_no Required	Category number
display_group Required Min : [1]~Max : [3]	detailed product category 1 : Regular product 2 : Recommend product 3 : New product

Parameter

Description

shop_no

Shop Number

DEFAULT 1

category_no
Required

Category number

display_group
Required

Min : [1]~Max : [3]

detailed product category

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

Request Copy

Response Copy

Mains products

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

Endpoints

GET /api/v2/mains/{display_group}/products

Mains products properties

Attribute	Description
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages
product_no	Product number
product_name	Product name
manufacturer_name	Manufacturer
origin_place_value	origin
retail_price	Product retail price
price	Price
interest_free_period	interest-free installment payment period
eng_product_name	English name of product
custom_product_code	Custom product code
point_amount	Points
brand_name	Brand name
model_name	Model name
price_excluding_tax	Product price
tax	Tax amount
product_code	Product code
simple_description	Simple Product Description
summary_description	Product Summary Description
supplier_name	Supplier name
made_date	Date of manufacture
review_count	number of reviews
expiration_date	Expiration date
coupon_discounted_price	Coupon-discounted price
trend_name	Trend name
shipping_scope	Shipping information
shipping_fee_type	Shipping charge T: Free shipping R: Fixed rate M: Charge according to purchase amount D: Use different shipping charges per different purchase amount W: Use different shipping charges by product weight C: Use different shipping charges by quantity N: Use different shipping charges per different quantity
shipping_rates	Charge shipping by section
shipping_fee	shipping fee
discount_price	Discounted price
optimum_discount_price	Fully discounted price
shipping_method	Shipping method
promotion_period	Discount & sales schedule
color	Product color
translated_additional_description	Translated additional description
stock_quantity	Inventory quantity
question_count	number of product inquiries
product_article_count	number or product boards

Retrieve a list of products in main category

GET /api/v2/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
mobile	whether a mobile setup value has been retrieved T: Use F: Do not use
shop_no	Shop Number DEFAULT 1
display_group Required	main category number
limit Min : [1]~Max : [200]	Limit DEFAULT 100
offset Max : [8000]	Start location of list DEFAULT 0

Request Copy

Response Copy

Products

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

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

Endpoints

GET /api/v2/products
GET /api/v2/products/count
GET /api/v2/products/{product_no}

Products properties

Attribute	Description
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages
product_no	Product number System assigned code. This code cannot be duplicated.
product_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	Product code System assigned code. This code cannot be duplicated.
custom_product_code Max Length : [40]	Custom product code You may assign this code manually in case of stock management or other reasons.
product_name Max Length : [250]	Product name Name of product. Basic information to search the product and seperate each product. You may input this with HTML.
eng_product_name Max Length : [250]	English name of product English name of product. Necessary when shipping to abroad.
model_name Max Length : [100]	Model name Model name of product
price_excluding_tax	product price (before VAT)
price	Product price Selling price. Price that before applying coupon or other benefits. At the time of product create, all multi-shopping mall's products have the same price. If you want to enter a different price for each multi-shopping mall, you can enter the price differently by modifying the product. ※ Price of product when automatically calculated = [ Value of supply + (Value of supply * Rate of margin) + addtional cost ]
retail_price	Product retail price General price of the product in market. This is used to compare the price of a shopping mall and to emphasize the price of a shopping mall.
display	Whether display User can choose product should be displayed or not. If product is not displayed, customer can't access product thus cannot buy the product. T: Display F: Do not display
selling	whether selling User can choose product status should be selling or not. If product is not selling, customer can still access product but cannot buy the product since the product will be displayed as "Sold out". If display is FALSE and selling is TRUE, customer can't access product thus cannot buy the product. T: Sell F: Do not sell
product_used_month Max : [2147483647]	Months of using the used product
summary_description Max Length : [255]	Product Summary Description Summary description of product. Can Exposed at product display screen. You may input description with HTML.
product_tag	Product tag Search tags.
tax_calculation	Tax calculation type A: Auto M: Manual
price_content Max Length : [20]	Alternative phrase of the selling price Price will be replaced by this text when sold-out or unavailable for some reasons.
buy_limit_by_product	whether purchase restriction individual setting T: use F: do not use
buy_limit_type	Purchase limitation Limit purchase as below information. N: Purchase is only available to customer accounts + Buy button is hidden M: Purchase is only available to customer accounts + Buy button is shown F: No purchase restrictions O: Purchase is only available to specific customer accounts + Buy button is hidden D: Purchase is only available to specific customer accounts + Buy button is shown
buy_group_list	customer tiers allowed to purchase the relevant product
buy_member_id_list	Authorized customer ID
repurchase_restriction	repurchase restriction T : restrict repurchase F : do not restrict repurchase
single_purchase_restriction	single purchase restriction T : restrict single purchase F : do not restrict on single purchase
buy_unit_type	Type of Purchase unit If the purchase unit of the product is set to 1 or more, the setting of whether the purchase unit is the item unit or the product unit P: Based on product O: Based on quantity
buy_unit	Minimum unit per purchase Minimum unit per purchase. Ex ) If product's minimum unit per purchase is 3, customer can only buy the product as multiple number of 3.
order_quantity_limit_type	Criteria of order quantity restriction If you limit the order quantity of the product, you can set whether the limit should be based on item or product unit. P: Based on product O: Based on quantity
minimum_quantity Max : [2147483647]	Minimum quantity per purchase Minimum quantity per purchase. Customer cannot buy the product below the minimum quantity.
maximum_quantity Max : [2147483647]	Maximum quantity per purchase Maximum quantity per purchase. Customer cannot buy the product above the maximum quantity. If the maximum order quantity is "no limit", it is displayed as "0".
points_by_product	individual settings for points F : use default setting T : individual setting
points_setting_by_payment	points settings by payment method B : Use the default reserve setting C : Earn based on the payment method
points_amount	points settings information
adult_certification	Age verification Whether the product requires adult certification. Customer needs to be authenticated to purchase products that require adult certification. T: Used F: Not used
detail_image	Product image Detail image' showing on the product detail page.
list_image	Catalog image List image' showing on the product category page, main page, product search result page.
tiny_image	Catalog thumbnail image Small list image' showing on the recently viewed page.
small_image	Gallery thumbnail image Reduced image' showing on the bottom side of the product detail page.
use_naverpay	whether use Naver Pay T: Used F: Not used
naverpay_type	Naver Pay sales type C : Naver Pay + Shopping Mall Products at the same time O : Naver Pay only products
manufacturer_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	Manufacturer code Code uses for designate specific manufacturer. This code generated automatically when register a new manufacturer. Set as default code(M0000000) if doesn't input.
trend_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	Trend code Code uses for designate specific trend. This code generated automatically when register a new trend. Set as default code(T0000000) if doesn't input.
brand_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	Brand code Code uses for designate specific brand. This code generated automatically when register a new brand. Set as default code(B0000000) if doesn't input.
made_date	Date of manufacture Date of manufacture of the product.
expiration_date Array Max : [2]	Expiration date Indicate the expiration date of intangible goods such as gift certificates or tickets or type goods such as food or cosmetics.
origin_classification	Origin classification Distinguish the origin of a product. F: domestic T: abroad E: other
origin_place_no	Origin place no List the origin number List all Origin by API If origin_classification is F (domestic), it is possible to enter origin only if foreign (foreign) is "F". If origin_classification is T (overseas), it is possible to enter origin only if foreign (foreign) is "T".
origin_place_value Max Length : [30]	Extra information for code of origin You may add additional information if 'origin_place_code' is 1800.
made_in_code	Origin country code
icon_show_period	Period for showing icon Period for showing icon.
icon Array Max : [5]	List of icon Icon displays at the product. This icon can use a purpose of emphsize selling.
product_material	Material of product The material of the item. You should enter each material and percentage of composing material if the product is has a multiple material.
list_icon	Recommend / sold out / new icon expose flag Either showing recommend / sold out / new icon will be exposed or not. ※ sold out icon ● Showing that the product is sold out ● Displays out of stock if mall using stock management function ※ recommend / new icon ● If the item is displayed in the area of category or the recommendation product on the main page or new product, shows the icon as it set.
approve_status	Approve request result N: New request for approval E: request for approval updated C: Approval complete R: Approval rejected I: Approval in progress Empty Value: Never requested
sold_out	Whether sold out or stock is available T: Out-of-stock F: No out-of-stock
discountprice	Product discount sale price Resource
decorationimages	Decoration Image Resource
benefits	Benefits Resource
options	Product Option Resource Can search with using embed parameter.
variants	Variants Resource Can search with using embed parameter.
clearance_category_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	Clearance category code clearance_category_code
additionalimages	additional image resource
exposure_limit_type	types of customers allowed to view the relevant product A: display to all M: display to customers only
exposure_group_list	customer tiers allowed to view the relevant product
set_product_type	Product bundle type C: integral type. S: assembled type
use_kakaopay	Whether to use Kakao Pay T: Used F: Not used
shipping_fee_type	Shipping charge (When using 'Shipping charge individually') Type of shipping charge. T: Free shipping R: Fixed rate M: Charge according to purchase amount D: Use different shipping charges per different purchase amount W: Use different shipping charges by product weight C: Use different shipping charges by quantity N: Use different shipping charges per different quantity
main	whether display at main Displays main display number when display products at main page such as "recommend product" or "new".
channeldiscountprices	Product discount sale price Resource
market_sync	Whether synced to online marketplace T: Used F: Not used
memos	Memos Resource Can search with using embed parameter.
hits	Product hits Resource Can search with using embed parameter.
seo	Product Seo Resource Can search with using embed parameter.
category	Category number Category of the product. Product is marked with this category.
project_no	planned exhibition number
description	Detail description of product Detail description of product. You may input description with HTML.
mobile_description	Mobile version of product description Mobile version of product description. Replace product description to the mobile version when customer access a mobile shopping mall.
separated_mobile_description	add mobile version T: add mobile version product details F: apply PC version product details
payment_info	Payment info Guidance for payment method. You may input this with HTML.
shipping_info	Shipping info Guidance for shipping method. You may input this with HTML.
exchange_info	Exchange info Guidance for exchange and return method. You may input this with HTML.
service_info	Service info Guidance for service warranty information. You may input this with HTML.
product_tax_type_text	Vat tax info Displays text set at VAT text setting menu.
simple_description	Simple Product Description Simple description of product. Can Exposed at product display screen. You may input description with HTML.
tags	Product Tag Resource Can search with using embed parameter.
has_option	Whether the option is used Shows product either has an option or not. Product with option offer various choices such as size, color, and flavors. T: use option F: do not use option
option_type	Type of option Shows type of option when "has_option" is TRUE. ● combination all-selected : Shows combination of 'all options' in 'a single selecbox'(button or radio button). ● combination separate-selected : Customer can choose 'options' at 'each selectbox'(button or radio button) and make 'a combination of option' based on 'the name of option'. ● linked with product : The way how to show type of option is similar to 'combination types' but this type can choose both 'necessary option' and 'selectable option'. This type can make 'unlimited combinations of options'. ● independently selectable : Customer can select 'each indepentent options'. 'Each option' will be generated as 'each variant'. C: Combination integration option S: Combination separation option E: Product connection F: Independent selection
shipping_calculation	Shipping calculation type A: Auto M: Manual
shipping_method	Shipping method Following is the method when 'individual_delivery' is TRUE 01: regular delivery 02: fast service (document only) 03: regular mail (document only) 04: delivery in person 05: delivery in person with bike or truck (within several hours) 06: other 07: cargo delivery 08: pickup at a store 09: delivery does not necessary
prepaid_shipping_fee	Whether prepaid shipping fee Returns null if shipping_calculation is A (autocomputation). C: Pay after delivery P: Prepaid B: Select Prepaid/Pay after delivery
shipping_period	Shipping period (When using 'Shipping charge individually') Average transit time for make a delivery.
shipping_scope	Shipping information Shows whether can only deliver domestically or can deliver to overseas too. Cannot set the type when 'Shipping charge individually' is FALSE. A: Domestic only C: Export only B: Can deliver both inland and overseas
shipping_area Max Length : [255]	Shipping area (When using 'Shipping charge individually') Available shipping region.
shipping_rates	Charge shipping by section If shipping_fee_type is R or N, you can set the shipping cost by defining shipping_fee in the array. If shipping_fee_type is M, D, W, C, you can set the shipping interval by defining the following in the array. shipping_rates_min: Shipping interval start shipping_rates_max: Shipping interval end shipping_fee: shipping
origin_place_code	Code of origin Code of origin
additional_information	Additional information list You may add additional information other than basic information.
relational_product	Related product Related or similar product of selected product. Registered related product display the bottom of the product detail page.
select_one_by_option	Whether select only one by option When using 'independently selectable' option type and this set as TRUE, customer can select only 1 item per option. If this set as FALSE, customer can select multiple items per option. ※ This Flag Is Only Available When Using 'Independently Selectable' Option Type. T: Use F: Do not use

Retrieve a list of products

GET /api/v2/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
channeldiscountprices embed	Product discount sale price Resource
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. Can search with using embed parameter.
additionalimages embed	additional image resource
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1
product_no	Product number Number of a product. You can search multiple item with ,(comma)
display	Whether display Search for products that displayed or not.
selling	whether selling Search for products that sell or not.
product_name	Product name Search for products of which names include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
product_code	Product code Search for products of which product codes include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
brand_code	Brand code Search for products with matching brand codes. You can search multiple item with ,(comma)
manufacturer_code	Manufacturer code Search for products with matching manufacturer code. You can search multiple item with ,(comma)
supplier_code	Supplier code Search for products with matching supplier code. You can search multiple item with ,(comma)
trend_code	Trend code Search for products with matching trend code. You can search multiple item with ,(comma)
product_tag	Product tag Search for products of which product search terms or tags include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
custom_product_code	Custom product code Search for products of which custom product codes include the search query you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
custom_variant_code	Custom variants code You can search multiple item with ,(comma)
price_min	Minimum price Search for products that price is over a certain range.
price_max	Maximum price Search for products that price is below a certain range.
retail_price_min Min : [0] Max : [2147483647]	Minimum retail price Search for products that retail price is over a certain range.
retail_price_max Min : [0] Max : [2147483647]	Maximim retail price Search for products that retail price is below a certain range.
supply_price_min	Minimum supply price Search for products that supply price is over a certain range.
supply_price_max	Maximum supply price Search for products that supply price is below a certain range.
created_start_date	Registered date start Search for products added after the search start date. Must be used with a search end date. If the start date is the same as the end date, results will be retrieved based on the date.
created_end_date	Registered date end Search for products added before the search end date. Must be used with a search start date. If the end date is the same as the start date, only results will be retrieved based on the date.
updated_start_date	Updated date start Search for products edited after the search start date. Must be used with a search end date. If the start date is the same as the end date, results will be retrieved based on the date.
updated_end_date	Updated date end Search for products edited before the search end date. Must be used with a search start date. If the end date is the same as the start date, results will be retrieved based on the date.
category	Category number Search for items that displayed at a certain category.
eng_product_name	English name of product Search for products of which product names (English) include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
supply_product_name	Supplier product name Search for products of which product names (supplier) include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
internal_product_name	internal product name You can search multiple item with ,(comma)
model_name	Model name Search for products of which model names include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
product_condition	Product condition Search for products of specific condition. You can search multiple item with ,(comma)
origin_place_value	Origin Extra information for code of origin. You may add additional information if 'origin_place_code' is 1800. You can search multiple item with ,(comma)
stock_quantity_max	Maximum stock search Search for items that product stock is below a certain value.
stock_quantity_min	Minimum stock search Search for variants that product stock is above a certain value. If a product has several items, it searches if any of the items meet the condition.
stock_safety_max	Search of maximum safety inventory quantity
stock_safety_min	Search of minimum safety inventory quantity
product_weight	Weight of product Search for items that weigh certain kilograms. You can search multiple item with ,(comma)
classification_code	Classification code You can search multiple item with ,(comma)
use_inventory	whether use inventory Whether use inventory management or not at the variants of the products. T: Use F: Do not use
category_unapplied	Unapplied Category Search for products that category unapplied. T : Search for products that category unapplied
include_sub_category	include sub category Search for products that include sub category. T: Included
additional_information_key	additional information key Search for products that has specific additional information. In order to search, key and value is necessary.
additional_information_value	additional information value Search for products that has specific additional information. In order to search, key and value is necessary.
approve_status	Approval Status N: Approval request (New product) status E: Approval request (Product modification) status C: Approved status R: Rejected status I: Checking status
since_product_no Min : [0] Max : [2147483647]	Search after a certain product number Search products from after a certain product number. Can search regardless of offset. ※ Cannot use below parameter when using this search condition. product_no sort order offset
product_bundle	Product bundle T: Use F: Do not use
option_type	Type of option You can search multiple item with ,(comma) C: Combination integration option S: Combination separation option E: Product connection F: Independent selection
market_sync	Whether synced to online marketplace T: Use F: Do not use
sort	Sort order created_date: Created Date updated_date: Updated Date product_name: Product Name
order	Order by asc: Ascending desc: Descending
offset Max : [5000]	Start location of list Set the start location of search result. DEFAULT 0
limit Min : [1]~Max : [100]	Limit Set the maximum number of search result. Example) input '10' shows only '10' result DEFAULT 10

Request Copy

Response Copy

Retrieve a count of products

GET /api/v2/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_no	Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1
product_no	Product number Number of a product. You can search multiple item with ,(comma)
display	Whether display Search for products that displayed or not.
selling	whether selling Search for products that sell or not.
product_name	Product name Search for products of which names include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
product_code	Product code System assigned code. This code cannot be duplicated. You can search multiple item with ,(comma)
brand_code	Brand code Search for products with matching brand codes. You can search multiple item with ,(comma)
manufacturer_code	Manufacturer code Search for products with matching manufacturer code. You can search multiple item with ,(comma)
supplier_code	Supplier code Search for products with matching supplier code. You can search multiple item with ,(comma)
trend_code	Trend code Search for products with matching trend code. You can search multiple item with ,(comma)
product_tag	Product tag Search for products of which product search terms or tags include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
custom_product_code	Custom product code Search for products of which custom product codes include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
custom_variant_code	Custom variants code You can search multiple item with ,(comma)
price_min	Minimum price Search for products that price is over a certain range.
price_max	Maximum price Search for products that price is below a certain range.
retail_price_min Min : [0] Max : [2147483647]	Minimum retail price Search for products that retail price is over a certain range.
retail_price_max Min : [0] Max : [2147483647]	Maximim retail price Search for products that retail price is below a certain range.
supply_price_min	Minimum supply price Search for products that supply price is over a certain range.
supply_price_max	Maximum supply price Search for products that supply price is below a certain range.
created_start_date	Registered date start Search for products added after the search start date. Must be used with a search end date. If the start date is the same as the end date, results will be retrieved based on the date.
created_end_date	Registered date end Search for products added before the search end date. Must be used with a search start date. If the end date is the same as the start date, results will be retrieved based on the date.
updated_start_date	Updated date start Search for products edited after the search start date. Must be used with a search end date. If the start date is the same as the end date, results will be retrieved based on the date.
updated_end_date	Updated date end Search for products edited before the search end date. Must be used with a search start date. If the end date is the same as the start date, results will be retrieved based on the date.
category	Category number Search for items that displayed at a certain category.
eng_product_name	English name of product Search for products of which product names (English) include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
supply_product_name	Supplier product name Search for products of which product names (supplier) include the search query that you enter. The search query is case-insensitive. You can search multiple item with ,(comma)
internal_product_name	internal product name You can search multiple item with ,(comma)
model_name	Model name Search for products of which model names contain the search term that you enter. The search term is case-insensitive. You can search multiple item with ,(comma)
product_condition	Product condition Search for products of specific condition. You can search multiple item with ,(comma)
origin_place_value	Origin Extra information for code of origin. You may add additional information if 'origin_place_code' is 1800. You can search multiple item with ,(comma)
stock_quantity_max	Maximum stock search Search for items that product stock is below a certain value.
stock_quantity_min	Minimum stock search Search for variants that product stock is above a certain value. If a product has several items, it searches if any of the items meet the condition.
stock_safety_max	Search of maximum safety inventory quantity
stock_safety_min	Search of minimum safety inventory quantity
product_weight	Weight of product Search for items that weigh certain kilograms. You can search multiple item with ,(comma)
classification_code	Classification code Search for products with matching custom classification code. You can search multiple item with ,(comma)
use_inventory	whether use inventory Whether use inventory management or not at the variants of the products. T: Use F: Do not use
category_unapplied	Unapplied Category Search for products that category unapplied. T : Search for products that category unapplied
include_sub_category	include sub category Search for products that include sub category. T: Included
additional_information_key	additional information key Search for products that has specific additional information. In order to search, key and value is necessary.
additional_information_value	additional information value Search for products that has specific additional information. In order to search, key and value is necessary.
approve_status	Approval Status N: Approval request (New product) status E: Approval request (Product modification) status C: Approved status R: Rejected status I: Checking status
since_product_no Min : [0] Max : [2147483647]	Search after a certain product number Search products from after a certain product number. Can search regardless of offset. ※ Cannot use below parameter when using this search condition. product_no sort order offset
product_bundle	Product bundle T: Use F: Do not use
option_type	Type of option You can search multiple item with ,(comma) C: Combination integration option S: Combination separation option E: Product connection F: Independent selection
market_sync	Whether synced to online marketplace T: Use F: Do not use

Request Copy

Response Copy

Retrieve a product resource

GET /api/v2/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_no	Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1
product_no Required	Product number Number of a product.
variants embed	Variants Resource Can search with using embed parameter.
memos embed	Memos Resource Can search with using embed parameter.
hits embed	Product hits Resource Can search with using embed parameter.
seo embed	Product Seo Resource Can search with using embed parameter.
tags embed	Product Tag Resource Can search with using embed parameter.
options embed	Product Option Resource Can search with using embed parameter.
discountprice embed	Product discount sale price Resource
decorationimages embed	Decoration Image Resource
benefits embed	Benefits Resource
additionalimages embed	additional image resource

Request Copy

Response Copy

Products decorationimages

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

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

Endpoints

GET /api/v2/products/{product_no}/decorationimages

Products decorationimages properties

Attribute	Description
shop_no	Shop Number
use_show_date	whether use show date T: Use F: Do not use
show_start_date	start date of show_date
show_end_date	end date of show_date
image_list	list of decoration image Horizontal position (image_horizontal_position) L: Left C: Center R: To the right Vertical position (image_vertical_position) T: Top C: Abort B: Bottom

Retrieve a list of product decoration images

GET /api/v2/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_no	Shop Number DEFAULT 1
product_no Required	Product number System assigned code. This code cannot be duplicated.

Parameter

Description

shop_no

Shop Number

DEFAULT 1

product_no
Required

Product number

System assigned code. This code cannot be duplicated.

Request Copy

Response Copy

Products discountprice

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

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

Endpoints

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

Products discountprice properties

Attribute	Description
pc_discount_price	PC discount price
mobile_discount_price	Mobile discount price
app_discount_price	Discounted price (App)

Retrieve a product discounted price

GET /api/v2/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_no	Shop Number DEFAULT 1
product_no Required	Product number

Parameter

Description

shop_no

Shop Number

DEFAULT 1

product_no
Required

Product number

Request Copy

Response Copy

Products hits

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

Endpoints

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

Retrieve a count of product views

GET /api/v2/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_no

Shop Number

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

DEFAULT 1

product_no
Required

Product number

System assigned code. This code cannot be duplicated.

Request Copy

Response Copy

Products icons

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

Endpoints

GET /api/v2/products/{product_no}/icons

Products icons properties

Attribute	Description
shop_no	Shop Number
use_show_date	whether use show date T: Use F: Do not use
show_start_date	start date of show_date
show_end_date	end date of show_date
image_list	list of product icon

Retrieve a list of product icons

GET /api/v2/products/{product_no}/icons

GET

Specification

Property	Description
SCOPE	mall.read_product
Request Limit	40

Request

Parameter	Description
shop_no	Shop Number DEFAULT 1
product_no Required	Product number

Parameter

Description

shop_no

Shop Number

DEFAULT 1

product_no
Required

Product number

Request Copy

Response Copy

Products options

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

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

Endpoints

GET /api/v2/products/{product_no}/options

Products options properties

Attribute	Description
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages
product_no Required	Product number System assigned code. This code cannot be duplicated.
has_option	Whether the option is used T: Use F: Do not use
option_type	Type of option Shows type of option when "has_option" is TRUE. ● combination : make 'a combination of option' based on 'the name of option'. ● linked with product : The way how to show type of option is similar to 'combination types' but this type can choose both 'necessary option' and 'selectable option'. This type can make 'unlimited combinations of options'. ● independently selectable : Customer can select 'each indepentent options'. 'Each option' will be generated as 'each variant'. T: Combination E: linked with product F: independently selectable
option_list_type	Option list type If you use the combined option, show the type of the combined option * combination all-selected : Shows combination of 'all options' in 'a single selecbox'(button or radio button). * combination separate-selected : Customer can choose 'options' at 'each selectbox'(button or radio button) and make 'a combination of option' based on 'the name of option'. If you use "linked with product" option or "independently selectable" option, S(separate selected) is used by default. C: Integrated type S: Separated type
options	Option
select_one_by_option	Whether select only one by option When using 'independently selectable' option type and this set as TRUE, customer can select only 1 item per option. If this set as FALSE, customer can select multiple items per option. ※ This Flag Is Only Available When Using 'Independently Selectable' Option Type. T: Use F: Do not use
use_additional_option	Whether use additional option T: Use F: Do not use
additional_options	Additional option
use_attached_file_option	Whether use attached file option T: Use F: Do not use
attached_file_option	Attached file option

Retrieve a list of product options

GET /api/v2/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_no

Shop Number

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

DEFAULT 1

product_no
Required

Product number

System assigned code. This code cannot be duplicated.

Request Copy

Response Copy

Products variants

Products Variants is the basic unit of goods sold in the shopping mall. Shopping malls usually sell the same items but different sizes or different colors to provide customers with different options.
Products Variants has the following Resource as a embedded Resource:

● Inventories

Endpoints

GET /api/v2/products/{product_no}/variants
GET /api/v2/products/{product_no}/variants/{variant_code}

Products variants properties

Attribute	Description
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages
variant_code Type : [A-Z0-9] Length Min : [12]~Max : [12]	Variant code System assigned code. This code cannot be duplicated.
options	Option
display	Whether display Whether display the variants or not. If this set as TRUE, customer may choose the variants at product detail page or product list page. If this set as FALSE, variants will not be displayed thus cannot buy the variants. T: Display F: Do not display
selling	whether selling Whether display the variants or not. If this set as TRUE, customer may choose the variants at product detail page or product list page. If this set as FALSE, variants will not be displayed thus cannot buy the variants. T: Sell F: Do not sell
additional_amount	Additional price Additional price for purchase the variants.
quantity	Available inventory
safety_inventory	minimum stock level
image	Variant image
inventories	Inventories Resource Inventory Resource of variants. Can search with using embed parameter.

Retrieve a list of product variants

GET /api/v2/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_no

Shop Number

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

DEFAULT 1

product_no
Required

Product number

System assigned code. This code cannot be duplicated.

inventories
embed

Inventories Resource

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

You can search multiple item with ,(comma)

Request Copy

Response Copy

Retrieve a product variant

GET /api/v2/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_no	Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1
product_no Required	Product number System assigned code. This code cannot be duplicated.
variant_code Required Type : [A-Z0-9] Length Min : [12]~Max : [12]	Variant code
inventories embed	Inventories Resource Can search with using embed parameter.

Request Copy

Response Copy

Products variants inventories

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

Endpoints

GET /api/v2/products/{product_no}/variants/{variant_code}/inventories

Products variants inventories properties

Attribute	Description
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages
variant_code Type : [A-Z0-9] Length Min : [12]~Max : [12]	Variant code System assigned code. This code cannot be duplicated.
quantity	Available inventory Available inventory to sale. The number will deduct when order or payment made. Available inventory counted to shows 'Sold out' or not.
safety_inventory	minimum stock level
origin_code	Shipping origin code

Retrieve inventory details of a product variant

GET /api/v2/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_no

Shop Number

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

DEFAULT 1

product_no
Required

Product number

System assigned code. This code cannot be duplicated.

variant_code
Required

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

Variant code

Variants code for search sales volume.

Request Copy

Response Copy

Productsdetail

Information added to a product details page will be retrieved.

Endpoints

GET /api/v2/productsdetail/{product_no}

Productsdetail properties

Attribute	Description
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages
product_no	Product number System assigned code. This code cannot be duplicated.
detail_image	Product image Detail image' showing on the product detail page.
small_image	Gallery thumbnail image Reduced image' showing on the bottom side of the product detail page.
additional_images 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.
product_name	Product name Name of product. Basic information to search the product and seperate each product. You may input this with HTML.
manufacturer_name	Manufacturer Name of manufacturer. Manufacturer name is the basic information for mall to distinguish each manufacturer.
origin_place_value	origin
retail_price	Product retail price General price of the product in market. This is used to compare the price of a shopping mall and to emphasize the price of a shopping mall.
price	Price Selling price. Price that before applying coupon or other benefits. At the time of product create, all multi-shopping mall's products have the same price. If you want to enter a different price for each multi-shopping mall, you can enter the price differently by modifying the product. ※ Price of product when automatically calculated = [ Value of supply + (Value of supply * Rate of margin) + addtional cost ]
interest_free_period	interest-free installment payment period A period of time during which no interest is charged
eng_product_name	English name of product English name of product. Necessary when shipping to abroad.
custom_product_code	Custom product code You may assign this code manually in case of stock management or other reasons.
points_amount	Points Amount of points that can be issued to customers for placing an order Either common settings for all payment methods or different settings for each payment method can be selected.
brand_name	Brand name
model_name	Model name Model name of product
price_excluding_tax	Product price Price of a product before VAT
tax	Tax amount
product_code	Product code System assigned code. This code cannot be duplicated.
simple_description	Simple Product Description Simple description of product. Can Exposed at product display screen. You may input description with HTML.
summary_description	Product Summary Description Summary description of product. Can Exposed at product display screen. You may input description with HTML.
supplier_name	Supplier name Name of supplier. Supplier name is the basic information for mall to distinguish each supplier.
made_date	Date of manufacture Date of manufacture of the product.
review_count	number of reviews Number of reviews added for a product
expiration_date	Expiration date Indicate the expiration date of intangible goods such as gift certificates or tickets or type goods such as food or cosmetics.
coupon_discounted_price	Coupon-discounted price Price of a product with coupon applied
trend_name	Trend name Name of trend.
shipping_scope	Shipping information Shows whether can only deliver domestically or can deliver to overseas too. Cannot set the type when 'Shipping charge individually' is FALSE.
shipping_fee_type	Shipping charge Returns null if shipping_calculation is A (autocomputation). T: Free shipping R: Fixed rate M: Charge according to purchase amount D: Use different shipping charges per different purchase amount W: Use different shipping charges by product weight C: Use different shipping charges by quantity N: Use different shipping charges per different quantity
shipping_rates	Charge shipping by section Per-product shipping fee shipping_rates_min: minimum value in the range shipping_rates_max: maximum value in the range shipping_fee: shipping fee
shipping_fee	shipping fee
discount_price	Discounted price Price of a product with discount applied
optimum_discount_price	Fully discounted price
shipping_method	Shipping method Shipping method
promotion_period	Discount & sales schedule A period of time during which discount is valid for a product
colors	Product color
translated_additional_description	Translated additional description
stock_quantity	Inventory quantity
question_count	number of product inquiries Number of inquiries added for a product
relation_count	Number of related products Number of products added as related products
product_material	Material of product
product_article_count	number or product boards Number of posts added for a product in Product board
additional_information	Additional information list Additional field created when adding or editing a product
payment_methods	Payment Method
add_products	Complementary products Number of products added as complementary products

Retrieve the details of a product

GET /api/v2/productsdetail/{product_no}

GET

You can check the items exposed on the product details page and their values.
You can check the product name, manufacturer, image, etc.

Specification

Property	Description
SCOPE	mall.read_product
Request Limit	40

Request

Parameter

Description

shop_no

Shop Number

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

DEFAULT 1

product_no
Required

Product number

System assigned code. This code cannot be duplicated.

mobile

whether a mobile setup value has been retrieved

T: Use
F: Do not use

Request Copy

Response Copy

Category

Property	Description
SCOPE	mall.read_category
Request Limit	40

Property	Description
SCOPE	mall.read_category
Request Limit	40

Property	Description
SCOPE	mall.read_category
Request Limit	40

Personal

Carts

Carts is a function that stores products in advance so that they can be ordered at once before ordering them.
In shopping cart resources, you can use the Front API to put certain products in your shopping cart, and in the Admin API, you can look up the shopping cart of a specific member.

Endpoints

POST /api/v2/carts

Carts properties

Attribute	Description
duplicated_item	Whether the item code in the cart is a duplicate T: Item duplicated F: Item not duplicated
variants	Item
product_no	Product number
basket_type	Cart type A0000: General A0001: Interest-free
prepaid_shipping_fee	Whether prepaid shipping fee P: Prepayment C: Pay after delivery

Create a shopping cart

POST /api/v2/carts

POST

Specification

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

Request

Parameter	Description
shop_no Min : [1]	Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1
variants	Item Variants information. Number and code of variants to create a cart.
quantity Required Available inventory variants_code Required Product item code options Array option_code Option code value_no Option value additional_option_values Array key Additional option key value type Additional option type name Additional option name value Additional option value
addtional_products	Item of the additional composition product
product_no Required	Product number System assigned code. This code cannot be duplicated.
basket_type Required	Cart type Cart type. Cart can be set as interest-free type for products that can be purchased with interest-free payment options. A0000: General A0001: Interest-free
duplicated_item_check Required	Duplicate check of the cart Tells whether to allow items with same item codes to added multiple times to cart. If allowed, items with same item codes are added. If not, items with same item codes are not added to cart. T: Duplicate item check F: No duplicate item check
prepaid_shipping_fee Required	Whether prepaid shipping fee P: Prepayment C: Pay after delivery

Request Copy

Response Copy

Products carts

Products carts are the resources to check the number of members who put a particular product in their cart.
You can inquire about the ID of the member who put a specific product in the shopping basket, the date of the item, and the number of members.

Endpoints

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

Retrieve a count of carts containing a product

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

GET

You can check the number of members who put a specific product in their shopping cart.

Specification

Property	Description
SCOPE	mall.read_personal
Request Limit	40

Request

Parameter

Description

shop_no

Shop Number

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

DEFAULT 1

product_no
Required

Product number

System assigned code. This code cannot be duplicated.

Request Copy

Response Copy

Attribute	Description
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages
category_no	Category number A unique identifier assigned to a product category. It cannot be used for more than one product category.
category_depth Min : [1]~Max : [4]	Category depth Depth of the product category. There are four product category depths.
parent_category_no	Parent Category Number The category number of the parent category when the category is either 2 depth (subcategory 1), 3 depth (subcategory 2), or 4 depth (subcategory 3) category. For example, “parent_category_no=1” indicates the parent category is main category.
category_name Max Length : [50]	Category name Name of the product category
full_category_name	Full Category Name The names of all parent categories to which the product category belongs.
full_category_no	Full Category Number This shows the category numbers of all parent categories that the current category belongs to.
root_category_no	Top category number The category number of the main category to which the category belongs
use_display	Display status Whether or not the product category is displayed. If it is “FALSE,” customers cannot access the product category. All multi-language stores must have the same settings. T: Displayed F: Not displayed
display_order	Display order The order in which the admin has placed product categories
hash_tags	Hashtag The list of hashtags in the current category. *The feature is only available when you use [Shopping Curation].

Parameter	Description
shop_no	Shop Number A unique number assigned to a store using the default store language or other languages DEFAULT 1
category_depth Min : [1]~Max : [4]	Category depth Search for the category that you want to retrieve with its category depth.
category_no	Category number Category number of the category you want to read
parent_category_no	Parent Category Number You can search for the category with its parent category number. If you want to search for main categories, enter “parent_category_number=1.”
category_name	Category name Search for product categories of which names include the search query that you enter. The search query is case-insensitive.