Method

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

POST : Create the entity.

GET: Read data the entity.

PUT : Modify(Update) the entity.

DELETE : Delete (delete) the entity.

Admin API Intro

example

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

Admin API

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

API Status Code

Code

Case

Solutions

200

When GET success, PUT success, DELETE success

201

When POST success

207

When status is vary as requested multiple objects.

Checks the error status of each object and deal with errors according to its status.

400

Server does not understand request1) Wrong Content-Type declaration2) Application/type is not json

Check for the "Content-Type" is application/json when request.

400

When not use URL Encoded character in API Request URL

Check whether API request URL has URL encoded character.

401

1) When AccessToken is missing2) When AccessToken is wrong3) When AccessToken is expired4) Unrecognizable client

Check whether the AccessToken is granted and used via valid process.

401

client_id is missing when using Front API

Check whether using valid client_id.

403

1) AccessToken does not include Scope authority2) 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 URL2) When cannot found resource3) When missing {#id}

Check the API reference for errors in URL.

422

When requested value is unprocessible with API reference1) Missing necessary parameter2) Not same with API reference

How to use GET API

Add search criteria

Example: If you want to search for products with prices over \1,000 within a particular brand
GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000
GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03

To search multiple sections of a parameter

Example: When inquiring information of products 11, 12 or 13
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13

Searching for Multi-shop information

Example: Check the products of shopping mall number 2
GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2

Detailed inquiry and single item check

Example: How to check product number 128 in detail
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products/128
Example: If you want to check the product number 128 using parameters
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?product_no=128

Pagination

Example: Check 100 products at a time
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?limit=100
Example: Check product 201 to product 300
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?limit=100&offset=200

Field Parameters

Example: When inquiring a product, check only the product name and product number parameters.
GET https://{{mallid}}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no

Embed parameters

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

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

1.Add search criteria

When inquiring API, you can search search conditions by adding parameters to the endpoint. If you are searching for multiple criteria together, you can add search criteria using the "&" separator.

You can also search using the "&" separator when searching for ranges such as start date, end date.

2. Search several conditions in parameter.

Multiple values can be retrieved simultaneously using commas(,) if supported by the API.

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

3. Multiple shopping mall information check

If you specify a particular shop_no during API lookup, you can inquire information in the corresponding multI-collar shopping mall. If you don't specify a particular shop_no, check the information in shopping mall 1(default shopping mall).

4. Check details and key

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

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

5. Pagination

If you have too many items to query when inquiring a list, all results may not be inquired at once. If you want to inquire more results at once, use the 'limits' parameter to expand the number of queries. If you do not use the 'limits' parameter, you can inquire only the default value of 'limits'.

The number of queries that can be extended with the limit parameter can be extended only to the maximum value defined for each API. If the limit limit can not be used for all data, the 'offset' parameter can be used. The 'offset' parameter can be used to determine the item to be inquired after starting with the previous product.

6. Field Parameters

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

7. Embed Parameters

Embeded Entity belonging to the product when inquiring an item (e.g. : If you need to inquire the item and inventory together, you can inquire the data of the lower entitywith using the ' embed ' parameter.

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

API Limit

X-Api-Call-Limit : 1/30

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

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

If the app calls the API once 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).

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

Authentication

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

Get Authentication Code

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

Example (request)

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

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

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

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

Get Access Token using refresh token

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

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

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

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

Specification

Property

Description

SCOPE

WRITE_APPLICATION

Request Limit

10

Request

Parameter

Description

order_nameRequired

Max Length : [100]

Order Name

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

order_amountRequired

Order Amount

Enter the amount of the order you want to user pay

return_urlRequired

Max Length : [250]

Return URL

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

Brands

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

Categories

Categories is a categories that can be used to display or classify products so that shopping mall customers can find them easily. Items must be displayed in one or more product categories for sale. A single item can be displayed in multiple product categories.
The {#id} of the Categories is "category_no".

Categories properties

Attribute

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

category_no

Category number

Unique number of each category. This number cannot be duplicated.

category_depth

Min : [1]~Max : [4]

Category depth

Shows which depth the category is. There are 4 level of category.

parent_category_no

Parent Category Number

Shows number of upper level of category if the category is among medium scale classification, small scale classification, and micro scale classification.

When parent_category_no = 1, the category indicates a large scale classification.

category_name

Max Length : [50]

Category name

Shows the name of the category

display_type

Display setting

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

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

full_category_name

Full Category Name

Shows the name of own level and upper level of category if the category is among medium scale classification, small scale classification, and micro scale classification.

full_category_no

Full Category Number

Shows the number of own level and upper level of category if the category is among medium scale classification, small scale classification, and micro scale classification.

root_category_no

Top category number

Shows number of highest level of category of which category belongs.

use_main

Main classification display status

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

T: Displayed F: Not displayed

use_display

Display status

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

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

T: Displayed F: Not displayed

display_order

Display order

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

soldout_product_display

Sold-out product display status

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

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

sub_category_product_display

Sub-category Product display status

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

T: Display F: Do not display

hashtag_product_display

Hashtag based product display

Whether use or not use hashtag based product display.

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

T: Display F: Do not display

hash_tags

Hashtag

Hashtags of the category.

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

product_display_scope

Category display scope

Whether to sort products by category or sort by area

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

Specification

Request

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

category_nameRequired

Max Length : [50]

Category name

The name of the category

display_type

Display setting

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

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

use_main

Main classification display status

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

T: Displayed F: Not displayed

use_display

Display status

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

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

T: Displayed F: Not displayed

soldout_product_display

Sold-out product display status

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

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

sub_category_product_display

Sub-category Product display status

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

T: Display F: Do not display

hashtag_product_display

Hashtag based product display

Whether use or not use hashtag based product display.

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

T: Display F: Do not display

hash_tags

Hashtag

Hashtags of the category.

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

product_display_scope

Category display scope

Whether to sort products by category or sort by area

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

product_display_typeproduct_display_keyproduct_display_sortproduct_display_period (Required only if key is S or C)

If the value is "by area", must enter these fields.normal_product_display_typenormal_product_display_keynormal_product_display_sortnormal_product_display_period (Required only if key is S or C)recommend_product_display_typerecommend_product_display_keyrecommend_product_display_sortrecommend_product_display_period (Required only if key is S or C)new_product_display_typenew_product_display_keynew_product_display_sortnew_product_display_period (Required only if key is S or C)

Request

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

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

use_main

Main classification display status

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

T: Displayed F: Not displayed

use_display

Display status

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

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

T: Displayed F: Not displayed

soldout_product_display

Sold-out product display status

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

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

sub_category_product_display

Sub-category Product display status

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

T: Display F: Do not display

hashtag_product_display

Hashtag based product display

Whether use or not use hashtag based product display.

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

T: Display F: Do not display

hash_tags

Hashtag

Hashtags of the category.

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

product_display_scope

Category display scope

Whether to sort products by category or sort by area

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

product_display_typeproduct_display_keyproduct_display_sortproduct_display_period (Required only if key is S or C)

If the value is "by area", must enter these fields.normal_product_display_typenormal_product_display_keynormal_product_display_sortnormal_product_display_period (Required only if key is S or C)recommend_product_display_typerecommend_product_display_keyrecommend_product_display_sortrecommend_product_display_period (Required only if key is S or C)new_product_display_typenew_product_display_keynew_product_display_sortnew_product_display_period (Required only if key is S or C)

Specification

Property

Description

SCOPE

WRITE_CATEGORY

Request Limit

30

Request

Parameter

Description

category_noRequired

Category number

Classifications

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

Coupons

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

Coupons properties

Attribute

Description

shop_no

Shop Number

DEFAULT 1

coupon_no

Coupon number

Number of coupon

coupon_type

Coupon type

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

O: Online coupon S: Off-line serial coupon

coupon_name

Coupon name

Name of coupon

coupon_description

Coupon description

Description of coupon

created_date

timezone

Created date

Date of coupon created

deleted

Whether coupon is deleted

Whether coupon is deleted or not

T: Deleted F: Not deleted

is_stopped_issued_coupon

Whether coupon is deleted and deactivated

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

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

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

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

available_min_price

Available price type

Coupon avilable purchase amount.

available_amount_type

Available Amount Type

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

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

issued_flag

Issued flag

Whether the coupon has been issued before or not.

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

created_start_date

Datetimezone

Search Start Date

Search for coupons that created after certain date.

created_end_date

Datetimezone

Search End Date

Search for coupons that created before certain date.

deleted

Whether coupon is deleted

Whether coupon is deleted or not

You can search multiple item with ,(comma)

T: deleted F: not deleted

DEFAULT F

pause_begin_date

Datetimezone

Coupon pause start date

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

pause_end_date

Datetimezone

Coupon pause end date

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

issue_order_path

Available order path

Available order path for coupon use.

W: PC M: Mobile P: Plus app

issue_order_type

Issue unit

Whether coupon issued based on product or order.

P: Product coupon O: Order coupon

issue_reserved

Issue reservation

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

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

available_period_type

Available date type

Type of available date for coupons useage.

You can search multiple item with ,(comma)

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

available_datetime

Datetimezone

Available datetime

Search for coupon that issue available at certain date.

Valid only if available_period_type is F

available_site

Available Site

Available order path for coupon use.

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

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

issued_flag

Issued flag

Whether the coupon has been issued before or not.

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

created_start_date

Datetimezone

Search Start Date

Search for coupons that created after certain date.

created_end_date

Datetimezone

Search End Date

Search for coupons that created before certain date.

deleted

Whether coupon is deleted

Whether coupon is deleted or not

You can search multiple item with ,(comma)

T: deleted F: not deleted

DEFAULT F

pause_begin_date

Datetimezone

Coupon pause start date

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

pause_end_date

Datetimezone

Coupon pause end date

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

issue_order_path

Available order path

Available order path for coupon use.

W: PC M: Mobile P: Plus app

issue_order_type

Issue unit

Whether coupon issued based on product or order.

P: Product coupon O: Order coupon

issue_reserved

Issue reservation

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

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

available_period_type

Available date type

Type of available date for coupons useage.

You can search multiple item with ,(comma)

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

available_datetime

Datetimezone

Available datetime

Search for coupon that issue available at certain date.

Valid only if available_period_type is F

available_site

Available Site

Available order path for coupon use.

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

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

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

Coupons issue

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

Specification

Property

Description

SCOPE

READ_STORE

Request Limit

30

Customergroup

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

Customers

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

Customers properties

Attribute

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

member_id

Max Length : [20]

Member id

member ID

name

Name

name of the customer

available_mileage

Available mileage

available mileage of the customer

group_no

Group number

number of member group of the customer

member_authentication

Member authentication

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

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

use_blacklist

Whether the member is blacklist

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

T: Set F: Not set

blacklist_type

Blacklist type

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

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

Specification

Property

Description

SCOPE

READ_CUSTOMER

Request Limit

30

Request

Parameter

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

DEFAULT 1

member_idRequired

Member id

member id

limit

Max : [100]

Limit

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

DEFAULT 10

offset

Max : [10000]

Start location of list

Set the start location of search result.

Get a customers memo

Definition

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

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

T: Receive F: Do not receive

news_mail

Whether to receive news mails

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

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

wedding_anniversary

Date

Wedding anniversary

wedding anniversary of the customer

birthday

Date

Birthday

Birthday of the customer

solar_calendar

Whether it is a solar calendar

Whether birthday is based on solar calendar or not.

T: Solar calendar F: Lunar calendar

total_mileage

Total mileage

total mileage of the customer

available_mileage

Available mileage

available mileage of the customer

used_mileage

Used mileage

used mileage of the customer

address1

Max Length : [255]

Address 1

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

address2

Max Length : [255]

Address 2

The detailed address of the customer.

group_no

Group number

number of member group of the customer

job_class

Job class

job class of the customer

job

Job

job of the customer

zipcode

Max Length : [14]

Zipcode

created_date

timezone

Created date

signup date of the customer

member_authentication

Member authentication

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

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

use_blacklist

Whether the member is blacklist

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

T: Set F: Not set

pointfy_member

Pointify Member Flag

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

T: Set F: Not set

blacklist_type

Blacklist type

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

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

last_login_date

timezone

Last login date

last login date of the customer

member_authority

Member authority

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

Search start date of member join date in case search_type is created_date. Can search member for which joined after a certain date.

member_id

Max Length : [20]

Member id

member ID

news_mail

Whether to receive news mails

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

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

sms

Whether to receive SMS

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

T: Receive F: Do not receive

group_no

Group number

number of member group of the customer

search_field

Search field

Search field for targeted member.

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

keyword

Keyword

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

You can search multiple item with ,(comma)

date_type

Date type

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

Search start date of member join date in case search_type is created_date. Can search member for which joined after a certain date.

member_id

Max Length : [20]

Member id

member ID

news_mail

Whether to receive news mails

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

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

sms

Whether to receive SMS

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

Specification

Property

Description

SCOPE

WRITE_PRODUCT

Request Limit

30

Request

Parameter

Description

shop_no

Shop Number

display_groupRequired

Display Group

product_noRequired

Product number

Update a mains product

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

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

Specification

Property

Description

SCOPE

WRITE_PRODUCT

Request Limit

30

Request

Parameter

Description

display_groupRequired

Display Group

product_noRequired

Product number

Manufacturers

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

Manufacturers properties

Attribute

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

manufacturer_code

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

Manufacturer code

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

manufacturer_name

Max Length : [50]

Manufacturer name

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

Maximum 1,000,000 mileage can be given for a single request.Cannot deduct more than available mileage.

typeRequired

whether increase/decrease mileage

You can choose whether increase or decrease mileage.

increase : add mileage decrease : deduct mileage

reason

reason for provide mileage

Reason for increase / decrease mileage.

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.

Orders items

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

Orders items properties

Attribute

Description

shop_no

Shop Number

DEFAULT 1

item_no

Item no

Identification number of order item.

order_item_code

Order item code

Identification code of order item.

variant_code

Variant code

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

product_no

Product number

System assigned code. This code cannot be duplicated.

product_code

Product code

System assigned code. This code cannot be duplicated.

eng_product_name

English name of product

English name of product. Necessary when shipping to abroad.

option_id

Option id

Identification number of product option.

option_value

Option value

Option value of product option.

option_value_default

Default option

Default option value of product option.

additional_option_value

Additional option value

Additional option value of product option.

product_name

Product name

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

product_name_default

Default product name

Product name.

product_price

Product price

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

option_price

Option price

Additional price when option has additional price.

additional_discount_price

Additional discount price

Additional discount price for product.

app_item_discount_amount

앱 상품할인금액

quantity

Available inventory

Quantity of ordered product.

supplier_product_name

Supplier product name

Product name of supplier.

supplier_transaction_type

Supplier transaction type

Transaction type of supplier.

D: Direct registration type P: Fee type

supplier_id

Supplier id

ID of supplier.

supplier_name

Supplier name

Name of supplier.

tracking_no

Tracking number

Tracking number of order.

shipping_code

Shipping code

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

Specification

Request

Parameter

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

DEFAULT 1

order_idRequired

Order ID

Order ID

Order number.

Origin

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

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

product_name

Max Length : [250]

Product name

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

eng_product_name

Max Length : [250]

English name of product

English name of product. Necessary when shipping to abroad.

supply_product_name

Max Length : [250]

Supplier product name

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

model_name

Max Length : [100]

Model name

Model name of product

price

Product price

Selling price. Price that before applying coupon or other benefits.

At the time of product create, all multi-shopping mall's products have the same price. If you want to enter a different price for each multi-shopping mall, you can enter the price differently by modifying the product.

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

product_used_month

Max : [2147483647]

Months of using the used product

summary_description

Max Length : [255]

Product Summary Description

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

product_tag

Max Length : [200]

Product tag

Search tags.

margin_rate

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

Margin rate

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

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

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

Set as default code(M0000000) if doesn't input.

trend_code

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

Trend code

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

Set as default code(T0000000) if doesn't input.

brand_code

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

Brand code

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

Set as default code(B0000000) if doesn't input.

supplier_code

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

Supplier code

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

made_date

Date of manufacture

Date of manufacture of the product.

release_date

Date of release

Date of release of the product.

expiration_date

Array Max : [2]

Expiration date

Indicate the expiration date of intangible goods such as gift certificates or tickets or type goods such as food or cosmetics.

origin_classification

Origin classification

Distinguish the origin of a product.

F: domestic T: abroad E: other

origin_place_no

Origin place no

List the origin number List all Origin by APIIf origin_classification is F (domestic), it is possible to enter origin only if foreign (foreign) is "F".If origin_classification is T (overseas), it is possible to enter origin only if foreign (foreign) is "T".

origin_place_value

Max Length : [30]

Extra information for code of origin

You may add additional information if 'origin_place_code' is 1800.

icon_show_period

Period for showing icon

Period for showing icon.

icon

Array Max : [5]

List of icon

Icon displays at the product. This icon can use a purpose of emphsize selling.

hscode

HS code

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

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

product_weight

Weight of product

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

product_material

Material of product

The material of the item. You should enter each material and percentage of composing material if the product is has a multiple material.

created_date

timezone

Created date

Date when product registered.

updated_date

timezone

Updated date

Date when product modified.

english_product_material

English product material

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

cloth_fabric

Fabric of product

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

woven: Woven knit: Knit

list_icon

Recommend / sold out / new icon expose flag

Either showing recommend / sold out / new icon will be exposed or not.

※ sold out icon

● Showing that the product is sold out● Displays out of stock if mall using stock management function

※ recommend / new icon

● If the item is displayed in the area of category or the recommendation product on the main page or new product, shows the icon as it set.

select_one_by_option

Whether select only one by option

When using 'independently selectable' option type and this set as TRUE, customer can select only 1 item per option.If this set as FALSE, customer can select multiple items per option.

※ This Flag Is Only Available When Using 'Independently Selectable' Option Type.

Mobile version of product description. Replace product description to the mobile version when customer access a mobile shopping mall.

It can be displayed only in detail inquiry.

additional_image

Array Max : [20]

Additional image

'Additional image' showing on the bottom side of the product detail page. Displayed at similar location with 'Reduced image' and can see 'Additional image' when mouse over at PC version or swipe at mobile version.

It can be displayed only in detail inquiry.

payment_info

Payment info

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

It can be displayed only in detail inquiry.

shipping_info

Shipping info

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

It can be displayed only in detail inquiry.

exchange_info

Exchange info

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

It can be displayed only in detail inquiry.

service_info

Service info

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

It can be displayed only in detail inquiry.

product_tax_type_text

Vat tax info

Displays text set at VAT text setting menu.

It can be displayed only in detail inquiry.

set_product_type

Product bundle type

It can be displayed only in detail inquiry.

C: integral type. S: assembled type

country_hscode

HS code by country

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

It can be displayed only in detail inquiry.

simple_description

Simple Product Description

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

It can be displayed only in detail inquiry.

tags

Product Tag Entity

Can search with using embed parameter.

It can be displayed only in detail inquiry.

options

Product Option Entity

Can search with using embed parameter.

It can be displayed only in detail inquiry.

shipping_fee_by_product

Shipping fee by product

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

T: Free shipping R: Fixed rate M: Charge according to purchase amount D: Use different shipping charges per different purchase amount W: Use different shipping charges by product weight C: Use different shipping charges by quantity N: Use different shipping charges per different quantity

shipping_rates

Charge shipping by section

If shipping_fee_type is R or N, you can set the shipping cost by defining shipping_fee in the array.

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

It can be displayed only in detail inquiry.

clearance_category_eng

English name of product

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

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

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

It can be displayed only in detail inquiry.

clearance_category_kor

Korean product category for overseas customs clearance

Product name as Korean

It can be displayed only in detail inquiry.

clearance_category_code

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

Clearance category code

It can be displayed only in detail inquiry.

origin_place_code

Code of origin

Code of origin

It can be displayed only in detail inquiry.

additional_information

Additional information list

You may add additional information other than basic information.

It can be displayed only in detail inquiry.

image_upload_type

Image type

Image type when uploading image.

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

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

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

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

Specification

Property

Description

SCOPE

WRITE_PRODUCT

Request Limit

30

Request

Parameter

Description

display

Whether display or not

Whether display or not.

T: Display F: Do not display

DEFAULT F

selling

Whether selling or not

Whether selling or not.

T: Sell F: Do not sell

DEFAULT F

product_condition

Product condition

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

DEFAULT N

product_used_month

Max : [2147483647]

Months of using the used product

Used month for the product when product_condition is used product.

add_category_no

Category no

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

custom_product_code

Max Length : [40]

Custom product code

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

product_nameRequired

Max Length : [250]

Product name

Name of product.

eng_product_name

Max Length : [250]

English name of product

Name of product in english.

model_name

Max Length : [100]

Model name

Model name of product.

priceRequired

Max : [2147483647]

Product price

Price of product.

retail_price

Max : [2147483647]

Product retail price

supply_priceRequired

Max : [2147483647]

Product supply price

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

has_option

Whether the option is used

Has an option or not.

T: use option F: do not use option

DEFAULT F

option

Option

Enter the option name and option value to be modified

manufacturer_code

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

Manufacturer code

Manufacturer code.

DEFAULT M0000000

supplier_code

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

Supplier code

shipping_fee: shipping

DEFAULT S0000000

expiration_date

Array Max : [2]

Expiration date

Expiration date.

description

Detail description of product

Detailed description of product.

mobile_description

Mobile version of product description

Mobile version of product description. Replace product description to the mobile version when customer access a mobile shopping mall.

summary_description

Max Length : [255]

Product Summary Description

shipping_rates_max: Shipping interval end

simple_description

Simple Product Description

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

T: Free shipping R: Fixed rate M: Charge according to purchase amount D: Use different shipping charges per different purchase amount W: Use different shipping charges by product weight C: Use different shipping charges by quantity N: Use different shipping charges per different quantity

DEFAULT T

shipping_rates

Shipping rates

If shipping_fee_type is R or N, you can set the shipping cost by defining shipping_fee in the array.

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

List the origin number List all Origin by APIIf origin_classification is F (domestic), it is possible to enter origin only if foreign (foreign) is "F".If origin_classification is T (overseas), it is possible to enter origin only if foreign (foreign) is "T".

DEFAULT 1798

origin_place_value

Max Length : [30]

Extra information for code of origin

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

main

Whether displays at main or not

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

relational_product

Related product

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

product_material

Material of product

The material of the item. You should enter each material and percentage of composing material if the product is has a multiple material.

english_product_material

English product material

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

cloth_fabric

Fabric of product

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

woven: Woven knit: Knit

classification_code

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

Classification code

additional_price

Max : [2147483647]

Additional amount of the selling price

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

margin_rate

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

Margin rate

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

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

Specification

Property

Description

SCOPE

WRITE_PRODUCT

Request Limit

30

Request

Parameter

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

DEFAULT 1

product_noRequired

Product number

System assigned code. This code cannot be duplicated.

display

Whether display or not

You can choose product should be displayed or not.

T: Display F: Do not display

selling

Whether selling or not

Whether selling or not.

T: Sell F: Do not sell

product_condition

Product condition

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

product_used_month

Max : [2147483647]

Months of using the used product

Used month for the product when product_condition is used product.

add_category_no

Category no

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

delete_category_no

Deleted classification number

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

custom_product_code

Max Length : [40]

Custom product code

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

product_name

Max Length : [250]

Product name

Name of product.

eng_product_name

Max Length : [250]

English name of product

Name of product in english.

model_name

Max Length : [100]

Model name

Model name of product.

price

Max : [2147483647]

Product price

Price of product.

retail_price

Max : [2147483647]

Product retail price

supply_price

Max : [2147483647]

Product supply price

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

has_option

Whether the option is used

Has an option or not.

F: Option not used

manufacturer_code

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

Manufacturer code

Manufacturer code.

supplier_code

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

Supplier code

Supplier code.

expiration_date

Array Max : [2]

Expiration date

Expiration date.

description

Detail description of product

Detailed description of product.

mobile_description

Mobile version of product description

Mobile version of product description. Replace product description to the mobile version when customer access a mobile shopping mall.

T: Free shipping R: Fixed rate M: Charge according to purchase amount D: Use different shipping charges per different purchase amount W: Use different shipping charges by product weight C: Use different shipping charges by quantity N: Use different shipping charges per different quantity

shipping_rates

Shipping rates

If shipping_fee_type is R or N, you can set the shipping cost by defining shipping_fee in the array.

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

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

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

origin_classification

Origin classification

Distinguish the origin of a product.

F: domestic T: abroad E: other

origin_place_no

Origin place no

List the origin number List all Origin by APIIf origin_classification is F (domestic), it is possible to enter origin only if foreign (foreign) is "F".If origin_classification is T (overseas), it is possible to enter origin only if foreign (foreign) is "T".

origin_place_value

Max Length : [30]

Extra information for code of origin

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

main

Whether displays at main or not

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

relational_product

Related product

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

product_material

Material of product

The material of the item. You should enter each material and percentage of composing material if the product is has a multiple material.

english_product_material

English product material

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

cloth_fabric

Fabric of product

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

woven: Woven knit: Knit

classification_code

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

Classification code

additional_price

Max : [2147483647]

Additional amount of the selling price

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

margin_rate

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

Margin rate

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

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.

Specification

Property

Description

SCOPE

READ_PRODUCT

Request Limit

30

Request

Parameter

Description

shop_no

Shop Number

DEFAULT 1

product_noRequired

Product number

Products hits

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

Products hits properties

Count all products hits

Definition

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

Request

Products icons

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

Specification

Property

Description

SCOPE

READ_PRODUCT

Request Limit

30

Products images

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

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.

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

Specification

Property

Description

SCOPE

READ_PRODUCT

Request Limit

30

Request

Parameter

Description

product_noRequired

Product number

System assigned code. This code cannot be duplicated.

limit

Max : [100]

Limit

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

DEFAULT 10

offset

Max : [8000]

Start location of list

Set the start location of search result.

Get a products memo

Definition

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

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

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

option_list_type

Option list type

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

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

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

C: Integrated type S: Separated type

option_preset_code

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

Option set code

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

option

Option

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

select_one_by_option

Whether select only one by option

When using 'independently selectable' option type and this set as TRUE, customer can select only 1 item per option.If this set as FALSE, customer can select multiple items per option.

※ This Flag Is Only Available When Using 'Independently Selectable' Option Type.

T: Use F: Do not use

option_preset_name

Option preset name

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

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

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

option_list_type

Option list type

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

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

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

S: Combination separation option C: Combination integration option

option

Option

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

select_one_by_option

Whether select only one by option

When using 'independently selectable' option type and this set as TRUE, customer can select only 1 item per option.If this set as FALSE, customer can select multiple items per option.

※ This Flag Is Only Available When Using 'Independently Selectable' Option Type.

T: Used F: Not used; Existed only in the independent type; Process the selected value by option if being checked.

option_preset_name

Option preset name

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

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

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

S: Combination separation option C: Combination integration option

option_preset_code

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

Option set code

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

option

Option

Enter the option name and option value to be modified

original_option

Option value before modification

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

select_one_by_option

Whether select only one by option

When using 'independently selectable' option type and this set as TRUE, customer can select only 1 item per option.If this set as FALSE, customer can select multiple items per option.

※ This Flag Is Only Available When Using 'Independently Selectable' Option Type.

T: Used F: Not used; Existed only in the independent type; Process the selected value by option if being checked.

option_preset_name

Option preset name

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

Specification

Property

Description

SCOPE

READ_PRODUCT

Request Limit

30

Request

Parameter

Description

shop_no

Shop Number

DEFAULT 1

product_noRequired

Product number

Products seo

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

Products seo properties

Attribute

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

meta_title

Browser title

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

meta_author

Meta tag 1: Author

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

meta_description

Meta tag 2: Description

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

meta_keywords

Meta tag 3: Keywords

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

meta_alt

Alt text of product image

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

search_engine_exposure

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.

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

Products variants

Products Variants is the basic unit of goods sold in the shopping mall. Shopping malls usually sell the same items but different sizes or different colors to provide customers with different options.
The {#id} of the Products Variants is "variants_code".
Products Variants has the following Entity as a embedded Entity:

Option of variants. This indicates which option the variants consists of. The variants is able to purchase when customer choose the option.

custom_variant_code

Max Length : [40]

Custom variants code

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

display

Whether display or not

Whether display the variants or not. If this set as TRUE, customer may choose the variants at product detail page or product list page. If this set as FALSE, variants will not be displayed thus cannot buy the variants.

T: Sell F: Do not sell

selling

Whether selling or not

Whether display the variants or not. If this set as TRUE, customer may choose the variants at product detail page or product list page. If this set as FALSE, variants will not be displayed thus cannot buy the variants.

T: Display F: Do not display

additional_amount

Additional price

Additional price for purchase the variants.

inventories

Inventories

Inventory Entity of variants.

duplicated_custom_variant_code

Whether duplicate custom variant code

T: Duplicated F: Not duplicated

product_noRequired

Product number

System assigned code. This code cannot be duplicated.

List all products variants

Definition

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

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

display

Whether display or not

Whether display the variants or not. If this set as TRUE, customer may choose the variants at product detail page or product list page. If this set as FALSE, variants will not be displayed thus cannot buy the variants.

T: Display F: Do not display

selling

Whether selling or not

Whether display the variants or not. If this set as TRUE, customer may choose the variants at product detail page or product list page. If this set as FALSE, variants will not be displayed thus cannot buy the variants.

Products variants inventories

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

Products variants inventories properties

Attribute

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

variant_code

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

Variant code

System assigned code. This code cannot be duplicated.

use_inventory

Whether use inventory or not

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

T: Use F: Do not use

important_inventory

Whether it is an important inventory

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

A: General inventory B: Important inventory

inventory_control_type

Inventory check criteria

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

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

A: Based on order B: Based on payment

display_soldout

Whether to display sold-out or not

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

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

quantity

Available inventory

Available inventory to sale. The number will deduct when order or payment made. Available inventory counted to shows 'Sold out' or not.

List all products variants inventory

Definition

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

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

T: Use F: Do not use

important_inventory

Whether it is an important inventory

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

A: General inventory B: Important inventory

inventory_control_type

Inventory check criteria

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

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

A: Based on order B: Based on payment

display_soldout

Whether to display sold-out or not

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

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

quantity

Available inventory

Available inventory to sale. The number will deduct when order or payment made. Available inventory counted to shows 'Sold out' or not.

Reports salesvolume

SalesVolume is the quantity of goods sold in the shopping mall. The sales quantity is updated periodically, so it may not be reflected in real time.

Reports salesvolume properties

Attribute

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

collection_date

Settlement collection date

Collection date on which sales volume statistics were collected

collection_hour

Settlement collection time

Collection time when sales volume statistics were collected

product_price

Product price

Price of the product.

product_option_price

Product option price

Additional price for option.

settle_count

Quantity completely paid

Count for payment complete order at search period.

exchane_product_count

Quantity of products completely exchanged

Quantity exchanged for the item during the searched period.

cancel_product_count

Quantity completely cancelled

Count canceled product withint search period.

return_product_count

Quantity of products completely returned

Count returned product at search period.

updated_date

timezone

Final data renewal time

Shows time when sales quantity statistical data is updated.

variants_code

Variant code

Variants code of the product.

product_no

Product number

total_sales

Total sales volume

Total quantity sold during the time period that the item was searched.

Search start date for count sales volume(by order date).Must use with 'updated end date' simultaneously.

end_dateRequired

Datetimezone

Search End Date

End date of search for sales volume(by order date).Must use with 'start_date' simultaneously.

Reviews

Reviews is reviews written by customers in a shopping mall after using a product or service. To use the Reviews API, you first need to make sure that shopping mall using the Reviewtalk service in the shopping mall.

Specification

Property

Description

SCOPE

WRITE_APPLICATION

Request Limit

10

Request

Parameter

Description

script_noRequired

Unique number of script

Unique number of script

Shops

Shops is information of multi shopping malls that are created when two or more shopping malls are operated. Multi-shopping malls can be created up to 5, and they can be created in different languages and currencies, which can be used to operate multilingual shopping malls.
The {#id} of Multi Shops is "shop_no".

Specification

Request

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

DEFAULT 10

offset

Max : [8000]

Start location of list

Set the start location of search result.

Store

The store can get the basic information of the shopping mall such as shopping mall name, manager information, business registration number and customer center phone number of shopping mall.

Store properties

Attribute

Description

shop_no

Shop Number

Multi shopping mall number used for shopping mall classification.

shop_name

Shop name

mall_id

Store ID

Shopping mall ID. Also used in store manager's name and used in base domain.

base_domain

Base domain

Auto generated and free default domain. You can access the shoopping mall with this domain.

primary_domain

Primary domain

A representative domain connected to a shopping mall. It is dispalyed only when connecting representative domains.

company_registration_no

Company registration number

The business registration number of the shopping mall issued in the country where the business is located.

company_name

Company name

Business name or company name registered at the time of business registration.

president_name

CEO

The name of the representative registered at the time of business registration.

company_condition

Business

Business registered at business registration.

company_line

Business category

Business category registered at business registration.

country

Country of business

Name of the country where the business is located.

zipcode

Zipcode

Postal code of your business

address1

Address 1

Business address (city / county / province)

address2

Address 2

Business address (street address)

phone

Office phone number

fax

Office fax number

email

Email

The representative email of the mall. It is used as a sender's e-mail address when sending an automatic mail to a customer. It is also used as an e-mail address when an manager receives an automatic mail.

mall_url

Shopping mall address

mail_order_sales_registration

Report mail-order business

T:Reported F:Not Reported

mail_order_sales_registration_number

Mail-order business report number

missing_report_reason_type

Reason of no mail-order business report

If you did not report mail-order business, Its reason.

missing_report_reason

Detailed reason of no mail-order business report

If the reason for not report mail-order business is "other", the reason for detail.

about_us_contents

About us

A brief introduction to the mall. It is displayed on the company introduction page of the shopping mall.

company_map_url

Company map URL

Show a brief map of the mall. It is displayed on the company introduction page of the shopping mall.