.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 Shopify and how it works.
Requirements
Smartship requires below information to access your Shopify orders.
•
Shop ID : Shopify shop seller ID
•
Shop Domain : Shopify seller Domain
•
Api Key : Issued by Shopify (see guide below)
•
Admin Api access Token : Issued by Shopify (see guide below)
Setting up Shopify API for Smartship
1. Get API KEY from Shopify
Shopify service can query/issue API keys by following these steps.
1.
Log int to the Myshopify and enter the Apps > Apps and sales channels menu.
2.
Press the [Develop apps] button.
3.
Press the [Create an app] button.
4.
Enter the app name randomly and press the [Create app] button.
5.
Click the Configure button in the Configuration menu.
6.
Search or check the permissions that the API will allow, and then click the [Save] button (required permissions must be included)
Required permissions for API use
•
read_analytics
•
write_assigned_fulfillment_orders
•
read_assigned_fulfillment_orders
•
write_customers
•
read_customers
•
write_discounts
•
read_discounts
•
write_draft_orders
•
read_draft_orders
•
write_fulfillments
•
read_fulfillments
•
write_inventory
•
read_inventory
•
read_locations
•
write_merchant_managed_fulfillment_orders
•
read_merchant_managed_fulfillment_orders
•
write_order_edits
•
read_order_edits
•
write_orders
•
read_orders
•
write_script_tags
•
read_script_tags
•
write_shipping
•
read_shipping
•
read_shopify_payments_disputes
•
write_third_party_fulfillment_orders
•
read_third_party_fulfillment_orders
•
write_translations
•
read_translations
7.
When you press the [Install app] button in the API credentials menu, a notification window appears.
Press the [Install] button in this notification window to issue API KEY and ADMIN API Access Token.
The token that comes out when you press "Reveal token once" will be released only once, so please copy and save the token.
2. Register Shopify 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 “Shopify" 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 Shopify Shop ID.
•
Shop Domain : Enter Shopify seller domain.
•
API KEY: Enter the API KEY issued by 1. Get API KEY from Shopify
•
Admin API Access Token: Enter the ADMIN API Access Token issued by 1. Get API KEY from Shopify
•
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 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.