.png&blockId=78c9ff9a-717f-4cfb-9b99-87bbb83a5b89)
.png&blockId=a2201b79-1fa4-4228-8f36-abed02fb5059)
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 Shopee and how it works.
Requirements
Smartship requires below information to access your Shopee orders.
•
Shop ID : Automatically assigned Shop ID(see guide below)
•
Live Parter ID : Issued by Shopee Open Platform(see guide below)
•
Live Key : Issued by Shopee Open Platform(see guide below)
Setting up Shopee API for Smartship
1. Get API KEY from Shopee
Shopee service can query/issue API keys by following these steps.
1.
Log int to the Shopee Open Platform and enter the Console menu.
2.
Press the [Add New APP] button.
3.
After simply entering the basic information, press the [Submit] button to issue a Test Key.
App Category: Select ‘Seller In House System’.
*If the wrong category is selected, it will not connect to Smartship.
4.
It is not possible to link with the Test Key, so please press the [Go-Live] button to proceed to the next step.
Smartship login information must be provided to Shopee in order to proceed.
Smartship login information to proceed to the next step
- URL : https://smartship.qxpress.net/home
- Test Username : test_user
- Test Password : #qxpress-21
- IP Address : 211.115.121.4
211.115.121.6
211.115.102.134
20.214.92.38
20.249.181.82
20.249.181.119
* By Shopee’s policy, you will be requested to confirm IP information on 90 days cycle.
Please enable IP whitelist setting.
otherwise, smartship won’t the correct data about your order including the delivery address.
5.
Enter the Smartship login information provided above and press the [Submit] button to issue the Live Partner id and Live Key.
2. Check Shop ID in Shopee
1.
Please access KRSC or Seller Center and click Shop SKU or My Products.
2.
Click on the left More of the listed product and click Live Preview.
3.
The middle number after the product in the address bar (8-10 digits) is the Shopee ID.
3. Register Shopee API KEY on Smartship
Path : Smartship > Order > Sales Site API > API Setting
You can set up API connection by following the steps below.
1.
After entering the Sales Site API settings page, Click the "New registration" button at the top.
2.
Select “Shopee" Logo and please scroll to the "Sales Site Linkage Registration".
3.
Please enter the information necessary for setting up API linkage and register.
•
App Name : Enter the App Name added by 1. Get API KEY from Shopee.
•
Live Partner ID : Enter the Live Partner issued by 1. Get API KEY from Shopee.
•
Shop ID : Enter the Shop ID issued by 2. Check Shop ID in Shopee.
•
Live Key : Enter the Live Key issued by 1. Get API KEY from Shopee.
•
Press the [Get Auth] button and select API connection settings options. Details can be found 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.
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 Shopee Order Status
Smartship pulls orders with, “To Process” status, among sales orders from Shopee . (To Ship)
If the waybill is printed or make status changed after delivery starting, then Smartship can’t get the correct info.
In this case, you must create shipping orders at Smartship by manually.
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 Shopee product.
Path: Shopee Seller Center > Products > My Products
1.
Enter the code for each product on the Shopee Product registration screen.
•
In your product managing page, input the value to “Parent SKU” to map with, if it is a single product without an option.
•
Enter the “SKU” for each option if it is an optional selection.
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.