Search
Duplicate

Shopby 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 Qoo10 and how it works.
Requirements
Smartship requires below information to access your Shopby orders.
Shop ID : Shopby Login ID

Setting up Shopby API for Smartship

1. Get API KEY from Shopby

If you want to fulfill Shopby sales orders on your smartship, install the Qxpress Smartship app from the Shopby App Store.
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.

2. Finalize settings in SmartShip

After installing the Smartship app from Shopby App Store and completing the linking, you will see that Shopby 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 Shopby Order Status

Smartship pulls orders with “Paid”, “Preparing goods” and “Preparing for delivery” status, among sales orders from Shopby.
If you link manually, please link based on Shopby ‘order date’.

Shopby order linked invoice number update

The invoice number is updated to Shopby when the cargo with the barcode label is received at QFC (QX warehouse) or when the invoice is printed from the smartship.
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. On the other hand, if you print out the invoice and update it in Smartship, the courier will be updated in Qxpress and the invoice number will be updated in the form of QSP~.
Path : Smartship > Waybill > Print Waybill
If you want to print a packing label or invoice, you can go to the following path to print it out.

Connecting SKU to the product sold (When using Fullfillment)

If you want to use Auto Stock Qty Sync and fulfillment services, please connect the Smartship SKU to the Shopby product.
Path : Shopby > Item list or Item registration
1. Enter the code for each product on the Shopby Product registration screen.
In your product managing page, input the value to “Seller management code” to map with, if it is a single product without an option.
Enter the “Inventory code” for each option if it is an optional selection.
How to set option management code Path : Shopby > Item List or Item Registration > Click the [옵션수정] button under Options > Enter [옵션관리코드] in a new window
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.