新Shopify API對接 - 自定義應(yīng)用
時間:2022-06-08
Shopify API已經(jīng)更新,原專有應(yīng)用(Private app)已移除,更新為自定義應(yīng)用(Custom app),若您的店鋪是新開店鋪或者舊店鋪無法通過原有Private app授權(quán)獲取訂單,請參照此頁面重新配置API對接。
與本章節(jié)有關(guān)的主題
1. 在Shopify允許自定義應(yīng)用開發(fā)
*重要提示*
1. 【州】(或?。┖汀韭?lián)系方式】(或手機號碼)在PFC系統(tǒng)中為必填欄位,這兩個欄位值為空將無法確認訂單。請?zhí)崆案耂hopify設(shè)置,將【收貨地址電話號碼】設(shè)置為必填。若指定國家地址不需要提供州名稱,可以直接復(fù)制城市名稱至州。
2. API獲取訂單時,系統(tǒng)默認將Shopify訂單ID填充至【參考號】欄位,參考號默認不允許重復(fù)。若您有多個Shopify店鋪需要添加至PFC系統(tǒng),請?zhí)崆案履腟hopify訂單前綴以區(qū)分不同店鋪的訂單。
1. 在Shopify允許自定義應(yīng)用開發(fā)
1. 登錄Shopify后臺,點擊左側(cè)目錄中的【設(shè)置】;
2. 點擊左側(cè)的【應(yīng)用和銷售渠道】,然后點擊右上角的【開發(fā)應(yīng)用】;
3. 若您是第一次使用開發(fā)應(yīng)用,則需要先點擊【允許自定義應(yīng)用開發(fā)】啟用應(yīng)用;
4. 在確認頁面點擊【允許自定義應(yīng)用開發(fā)】。
2. 創(chuàng)建Shopify應(yīng)用
1. 啟用自定義應(yīng)用后,點擊右上角的【創(chuàng)建應(yīng)用】;
2. 在彈出窗口中輸入應(yīng)用名稱PFC,選擇應(yīng)用開發(fā)者(默認是登錄賬戶),然后點擊【創(chuàng)建應(yīng)用】。
3. 配置Shopify應(yīng)用權(quán)限
1. 創(chuàng)建應(yīng)用成功后,點擊【配置】選項卡定義API權(quán)限;
2. 在【后臺API集成】欄位右側(cè),點擊【配置】;
3. 勾選以下列出的所有權(quán)限,然后點擊【保存】;
write_products, read_products,
write_product_listings, read_product_listings,
write_shipping, read_shipping,
write_fulfillments, read_fulfillments,
write_merchant_managed_fulfillment_orders, read_merchant_managed_fulfillment_orders,
write_locales, read_locales,
write_locations, read_locations,
write_assigned_fulfillment_orders, read_assigned_fulfillment_orders,
write_third_party_fulfillment_orders, read_third_party_fulfillment_orders,
write_draft_orders, read_draft_orders
write_orders, read_orders,
4. 安裝Shopify應(yīng)用
1. 配置權(quán)限完成后,點擊【API憑證】選項卡,然后點擊【安裝應(yīng)用】;
2. 在彈出窗口中,點擊【安裝】;
3. 安裝完成后,頁面會列出加密令牌,點擊【顯示一次令牌】;
4. 復(fù)制令牌至記事本。
注意:您只能在此頁面上看到一次后臺 API 訪問令牌,因為該令牌提供對敏感商店數(shù)據(jù)的 API 訪問。在頁面顯示訪問令牌后,請在安全的地方寫下或記錄該令牌,以便您可以再次參考它。請將令牌視為密碼。只能與您信任的開發(fā)人員分享訪問令牌。
5. 定義Shopify發(fā)貨和配送
1. 在您的Shopify后臺,點擊左下角的【設(shè)置】;
2. 點擊【發(fā)貨和配送】;
3. 根據(jù)需要定義一般運費或自定義運費。
請注意,您在發(fā)貨和配送設(shè)置中定義的運費名稱(Rate name)將被用于匹配PFC運輸方式。
6. 在PFC系統(tǒng)設(shè)置API
1. 登錄PFC系統(tǒng),點擊進入【出口轉(zhuǎn)運】>【訂單管理】>【API對接】,或;
2. 點擊進入【倉儲管理]> 【出口轉(zhuǎn)運】>【API對接】;
3. 如您是第一次在PFC系統(tǒng)中配置API,請在默認【API接口】選項卡中,點擊【生成密鑰】(若您已經(jīng)配置過API可忽略此步驟);
4. 在彈出窗口中點擊【生成】(您的API密鑰將展示在客戶ID右側(cè));
5. 切換至【Shopify】選項卡,然后點擊【Add】;
6. 在彈出窗口中,輸入您的Shopify店鋪域名(請輸入您第一次注冊Shopify時所使用的域名,不包含.myshopify.com);
7. 復(fù)制并粘貼您在步驟4中保存的API訪問令牌至【API密鑰】和【密碼】輸入框中;
8. 在【是否啟用】下拉選項中選擇【啟用】,其他兩個選擇根據(jù)需要選擇;
9. 在【運輸方式對應(yīng)】部分,點擊右側(cè)的【添加】定義您的自動運輸匹配規(guī)則;
9.1 在第一列【運輸方式】欄位,復(fù)制您在Shopify中所設(shè)置的運費名稱Rate name;
9.2 在第二列【PFC運輸方式】欄位,選擇您需要使用的運輸方式;
9.3 重復(fù)上述步驟直至完成了所有目標(biāo)國家的運輸匹配設(shè)置;
10. 根據(jù)需要設(shè)置默認申報價值和重量;
11. 若您需要使用倉儲服務(wù)來處理Shopify訂單,請選擇您已開通服務(wù)的倉庫;
12. 設(shè)置完成后點擊【生成】。
7. 批量獲取Shopify產(chǎn)品
配置API完成后,若您是通過倉儲管理發(fā)貨,則需要先在Shopify創(chuàng)建好產(chǎn)品,然后直接通過API把產(chǎn)品信息同步到PFC系統(tǒng)。當(dāng)然,您也可以從Shopify導(dǎo)出所有產(chǎn)品信息,然后更新至PFC模板批量導(dǎo)入至PFC系統(tǒng),詳細步驟請參考倉儲管理。
1. 登錄PFC系統(tǒng),點擊進入【出口轉(zhuǎn)運】>【訂單管理】>【API對接】,或;
2. 點擊進入【倉儲管理]> 【出口轉(zhuǎn)運】>【API對接】;
3. 在您的Shopify店鋪右側(cè),點擊【獲取訂單】;
4. 在彈出窗口中,選擇訂單的起止時間(時間范圍每次最多支持選擇3天);
5. 點擊【Acquire Product】。
8. 批量獲取Shopify訂單
當(dāng)您完成了所有的配置,并且有訂單需要發(fā)貨,您可以根據(jù)以下步驟獲取訂單;
1. 登錄PFC系統(tǒng),點擊進入【出口轉(zhuǎn)運】>【訂單管理】>【API對接】,或;
2. 點擊進入【倉儲管理]> 【出口轉(zhuǎn)運】>【API對接】;
3. 在您的Shopify店鋪右側(cè),點擊【獲取訂單】;
4. 在彈出窗口中,選擇訂單的起止時間;
5. 在Financial status下拉菜單中選擇【Paid】;
6. 根據(jù)需要選擇Fulfillment status;
7. 點擊【Acquire Order】。
系統(tǒng)將處理您的訂單請求并返回相應(yīng)的提示。若提示訂單創(chuàng)建成功,則您可以前往【出口轉(zhuǎn)運】>【訂單管理】>【出口訂單列表】>【草稿】查看代發(fā)貨訂單,或前往【倉儲管理】> 【出口轉(zhuǎn)運】>【倉儲訂單列表】>【草稿】查看倉儲訂單。
9. 確認Shopify訂單
1. 在PFC系統(tǒng)中,點擊進入【出口轉(zhuǎn)運】>【訂單管理】>【出口訂單列表】>【草稿】,或;
2. 點擊進入【倉儲管理】> 【出口轉(zhuǎn)運】>【倉儲訂單列表】>【草稿】;
3. 勾選需要的訂單,然后點擊上方的【提交】。
操作成功后,訂單將移送至【確認】狀態(tài)。
10. Shopify API對接常見問題解答
Q1. 獲取訂單失敗,提示“未將對象引用設(shè)置到對象的實例”,或”Not Found“該怎么操作?
A1. 請檢查您是否輸入了正確的Shopify店鋪名稱。此名稱必須與您第一次注冊Shopify所使用的名稱完全匹配。若您不知道第一次注冊時所使用的名稱,可以通過以下方法查看:
1. 登錄您的Shopify后臺;
2. 查看瀏覽器地址欄中的網(wǎng)址,復(fù)制https://和.myshopify.com中間所有的字符,這些字符就是您最初注冊Shopify使用的店鋪名稱。
Q2. 獲取訂單失敗,提示"[API] This action requires merchant approval for read_orders scope.",該怎么操作?
A2. 請檢查您在Shopify后臺的權(quán)限設(shè)置,必須開通以下權(quán)限才能獲取訂單:
write_products, read_products,
write_product_listings, read_product_listings,
write_shipping, read_shipping,
write_fulfillments, read_fulfillments,
write_merchant_managed_fulfillment_orders, read_merchant_managed_fulfillment_orders,
write_locales, read_locales,
write_locations, read_locations,
write_assigned_fulfillment_orders, read_assigned_fulfillment_orders,
write_third_party_fulfillment_orders, read_third_party_fulfillment_orders,
write_draft_orders, read_draft_orders
write_orders, read_orders,
Q3. 獲取訂單失敗,提示“Cannot find the product”,該怎么操作?
A3. 若您是使用倉儲管理來處理Shopify訂單,則您需要在Shopify產(chǎn)品中添加SKU,且此SKU必須與PFC系統(tǒng)中上架的SKU完全匹配(區(qū)分大小寫)。若您沒有完成此步驟,當(dāng)買家下單時,對應(yīng)的SKU值為空,系統(tǒng)無法匹配PFC SKU,則導(dǎo)致獲取訂單失敗。Shopify完善SKU信息后只對未來的訂單生效。若您的訂單在添加Shopify SKU之前已經(jīng)生成了,則您需要手動在PFC系統(tǒng)中創(chuàng)建訂單或者使用Excel批量上傳訂單。
Q4. 獲取訂單失敗,提示“Cannot find the channel code”,該怎么操作?
A4. 出現(xiàn)此提示可能有以下原因:
1. 所選擇的運輸方式已禁用。
2. 所選擇的運輸方式不再支持運送至訂單中的目的地國家。
系統(tǒng)可能會根據(jù)需要調(diào)整運輸方式,若您所選擇的運輸方式已被禁用,或目的地國家已被屏蔽,可以聯(lián)系您的客戶經(jīng)理為您推薦新的運輸方式并更新到設(shè)置中。
Q5. 獲取訂單成功,但是系統(tǒng)匹配的運輸方式并不是我所選擇的,該怎么操作?
A5. 請檢查您在Shopify設(shè)置中填寫的運費名稱(Rate name)與PFC設(shè)置中填寫的Rate name是否完全匹配(區(qū)分大小寫)。若系統(tǒng)無法匹配Rate name,則會默認為相應(yīng)訂單選擇PFCEXPRESS運輸方式。請注意一定要填寫運費名稱Rate name,而不是填寫運費規(guī)則標(biāo)題。
Q6. 獲取訂單失敗,提示已存在,該怎么操作?
A6. 出現(xiàn)此提示可能有以下原因:
1. 訂單參考號重復(fù),同一個訂單只能獲取一次,若之前已經(jīng)獲取過,必須將之前的訂單徹底刪除才能重新獲??;
2. 訂單的狀態(tài)不是已付款/未發(fā)貨。系統(tǒng)默認拉取已付款且是未發(fā)貨的訂單,若您的訂單是未付款/付款未結(jié)清/手動標(biāo)記為付款等狀態(tài),或者訂單已經(jīng)手動標(biāo)記發(fā)貨,系統(tǒng)不會拉取,您需要同時在Finance status下拉菜單和Fulfillment status下拉菜單選擇any來強制拉取此類訂單。