Search

Shopify 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 Shopify and how it works.

Setting up Shopify API for Smartship

1. Connect Shopify App from Smaratship

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.
Click Get Auth button.
3.
The Shopify AppStore will be opened. When a new window opens, click the Install Button for”Smart Ship” app.
4.
Then the shopify will require authentication. Enter your credential and the setup will be automatically completed.

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 Connect] button to verify that the connection is successful.

Collectable Shopify Order Status

Smartship pulls orders with, “Payment status = Paid” and “Fulfillment satatus = Unfulfilled” status, among sales orders from Shopify.
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 Shopify product.
Path : MyShopify > Products
1.
Enter the code for each product on the Shopify Product registration screen.
In your product managing page, input the value to “SKU” to map with, if it is a single product without an option.
For optional selections, press the [Edit SKUs] button and enter "SKU" for each option.
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.