.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 11th Street and how it works.
Requirements
Smartship requires below information to access your 11th Street orders.
•
Shop ID : 11th Street seller office ID
•
Api Key : Issued by 11th Street(see guide below)
Setting up 11th Street API for Smartship
1. Get API KEY from 11th Street
11th Street service can query/issue API keys by following these steps.
1.
Log int to the 11th open API center and enter the “Register/Confirm Service” menu.
2.
Please press the Seller API Information > [Modify] button.
3.
Please enter the IP information as follows.
•
Hosted or not : Please select "Direct Input".
•
Development Server IP : Please enter 211.115.121.4;211.115.121.6;20.214.92.38;20.249.181.82;20.249.181.119 (Separate with semicolons.)
•
Developer PC : Please enter 211.115.121.4;211.115.121.6;20.214.92.38;20.249.181.82;20.249.181.119
•
Commercial servers IP : Please enter 211.115.121.4;211.115.121.6;20.214.92.38;20.249.181.82;20.249.181.119
4.
Press the [Modify] button.
*If there is no MD in charge of 11th Street, please enter "None".
2. Register 11th Street 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 “11th Street" Logo and please scroll to the "Sales Site Linkage Registration".
3.
Please enter the information necessary for setting up API linkage and register.
•
Shop ID : Enter 11th Street Shop ID.
•
API Key : Enter the API KEY issued by 1. Get API KEY from 11th Street
•
Please also select other 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 11th Street Order Status
Smartship pulls orders with, “Payment completed” & “To ship” status, among sales orders from 11th Street.
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.
Update 11th Street Order Linked Invoice Number
•
Tracking No is updated to 11th Street when a cargo with packing label is received in the QFC (QX Warehouse) or when the invoice is printed from the Smartship.
Path : 11th Street Seller Office > Order management > Delivery management
•
If you want to print a packing label or invoice, you can go to the following path to print it out.
Path : Smartship > Order > Order Management
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 11th Street product.
Path: 11th Street seller office > Order management > Product inquiry/modification
1.
Enter the code for each product on the 11th Street Seller Office Product registration screen.
•
In your product managing page, input the value to “Seller product code” to map with, if it is a single product without an option.
•
Enter the “Seller inventory code” 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.