Search
Duplicate

Cafe24 API Instruction

Why we use the API and What is the API?

If you want to process your sales order remotely via Smartship, you will be required to link your sales site with Smartship through API integration. Once you link your accounts, Smartship can pull the sales orders, confirm order and update tracking information accordingly.
Whenever Smartship calls the API of the Sales site, it is required to get the authorization for access. And the sales site will generate the ‘API Key’ to each account and it works as the credentials. Thus Smartship will ask your ‘API Key’ instead of Login credentials.
This documents will explain how to set API integration with Cafe24 and how it works.
Requirements
Smartship requires below information to access your Cafe24 orders.
•
Shop ID : Cafe24 Login ID

Setting up Cafe24 API for Smartship

1. Install Smartship from the Cafe24 App Store

1.
Please click App > My App
2.
Click [Go to App Store] and install the ‘Qxpress Smartship’ app.
3.
Please click ‘Qxpress Smartship’ app
When you click on the app, it is linked to the smartship. If you do not have a smart ship account, you can connect to a new account, or if you have a smartship account, you can connect to your existing account. If you have a multi shop, it is automatically linked, so no additional linkage is required.

2. Finalize settings in SmartShip

After installing the Smartship app from Cafe24 App Store and completing the linking, you will see that Cafe24 has been added to your shopping mall linked account. For information on order processing options, please check ‘API Connection Setting Options’ below.

API connection settings options

We request to set your order processing options for your work efficiency. Here are the basic options you can set.
•
Automatic Order Integration
•
Automatic Order Confirmation
•
Automatic Fulfillment Shipping Instructions
•
Automatic Stock Qty Sync

Check API settings information

After registration the API, you can test connection to verify.
•
Click the [Test Connection] button to verify that the connection is successful.

Collectable Cafe24 Order Status

Smartship pulls orders with “preparing for delivery” status, among sales orders from Cafe24.
If you link manually, please link based on Cafe24 ‘order date’.

Cafe24 order linked invoice number update

Caution If the delivery company you use is not added to the Cafe24 delivery company management page, delivery processing may fail. Please add the courier company you will use on this page in advance.
Path: Cafe24 > Shop Setting > Delivery Setting
•
The invoice number is updated to Cafe24 when the cargo with the barcode label is received at QFC (QX warehouse) or when the invoice is printed from the smart ship.
•
When goods are received at QFC and the invoice number is updated, they are updated with the shipping agency's courier name and invoice number.
Path: Smartship > Waybill > Print Waybill
•
If you want to print a barcode label or invoice, you can print it by going to the path below.

Connecting SKU to the product sold (When using Fullfillment)

If you want to use inventory synchronization and fulfillment services, please connect the Smartship SKU to Cafe24 sales products.
1.
Enter the code for each product on the Cafe24 product screen.
•
If it is a single product without options, enter “your own product code”.
•
If it is a selected product with options, please enter “your own item code” for each option.
How to set option management code Cafe24 > Item List > Option/Stocks > Use Option (Use) > Enter the “your own item code”
Path : Smartship > Inventory > SKU Management
1.
Move to Smartship SKU Management menu.
2.
In the SmartShip SKU, enter the same product code that you entered in 1. How to set option management code on sales site.
•
For a single product with no options
◦
Register a SKU of a single option type, and enter a 'Seller defined code'.
•
For multi-product with options
◦
Enter ‘Seller defined code’ in the ‘Option SKU Info’ tab.
If you're registering and mapping a large number of products, it's helpful to include your "SKU Seller Management Code" when uploading to Excel.
3. Once the above is done, it will be created as a fulfillment order from the time the order is linked, and the inventory quantity will be synchronized at the time of shipment.

Creating a Cafe24 multi shopping mall

What is a multi shopping mall? Cafe24 provides a multi shopping mall service, and multi shopping malls can be operated for various purposes other than the main shopping mall. Multi shopping malls are automatically added to the API integration list without additional integration. Please refer to the guide below on how to create a multi shopping mall.
1.
Click Shopping Mall Settings > Channel Settings > Multi Shopping Mall.
2.
Click the [Add shopping mall] button.
3.
After completing the settings, click the [Save] button to add the multi shopping mall.
4.
You can check and select the added multi shopping malls at the top left.