1ship物流API

  • 發布時間：
  • 最後更新：
  • 分類： 網站設計

API網域及身分驗證

API端點：https://api.1ship.tw/

請在下列所有API的GET參數帶入MerchantID及APIKey
驗證資訊請至 https://admin.1ship.tw/setting_api 取得

GET

名稱 型態 字數限制 說明 必填
MerchantID string 8   是
APIKey string 40   是

批次拋單 /v1/CreateOrderBatch

POST(FormData)

名稱 型態 字數限制 說明 必填
Data json 多筆 最多50筆 是
Data[i].LogisticsType string   物流種類
FAMI：全家常溫B2C
FAMIC2C：全家常溫C2C
FAMIFREEZE：全家冷凍B2C
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C
HILIFEFREEZE：萊爾富冷凍B2C		 是
Data[i].ReceiverName string 20 收件人姓名
(只允許 空格數字 大小寫英文 中文字)		 是
Data[i].ReceiverPhone string 10 收件人電話 是
Data[i].ReceiverEmail string 50 收件人Email  
Data[i].SenderName string 20 寄件人姓名 是
Data[i].SenderPhone string 10 寄件人手機 是
Data[i].IsCollection string 1 是否貨到付款 N純寄送 Y代收 是
Data[i].GoodsAmount int   訂單金額(0~20000)
IsCollection為Y(代收)不能為0		 是
Data[i].StoreID string 11 門市店號 是
Data[i].OrderNumber string 20 訂單編號 是
Data[i].OrderDate datetime   下單時間(Y-m-d H:i:s) 是
Data[i].Measurement string 4 材積 S60 S90 S105

FAMI：S105
FAMIC2C：S105
FAMIFREEZE：S105
HILIFE：S105
HILIFEC2C：S105
HILIFEFREEZE：S90		 是
Data[i].ReservedNo string 20 保留編號
FAMIFREEZE：全家冷凍B2C
HILIFEFREEZE：萊爾富冷凍B2C
為必填		 是/否

回傳(JSON) 成功部分會跟批次查詢貨態一樣

名稱 型態 字數限制 說明 必傳
success int   執行結果 0成功 -1失敗 是
msg string   執行失敗說明，例如：
資料格式錯誤		  
data.orders array   success為0必傳  
data.orders[i].success int   單筆訂單執行結果 0成功 -1失敗 是
data.orders[i].msg string   執行失敗說明，例如：
上傳訂單失敗
查無此訂單		  
data.orders[i].data object     是
data.orders[i].data.OrderNumber string 20 訂單編號
(不論執行結果如何都會傳出)		 是(success -1也會)
data.orders[i].data.GoodsAmount int   訂單金額 是
data.orders[i].data.LogisticsType string   物流種類
FAMI：全家常溫B2C
FAMIC2C：全家常溫C2C
FAMIFREEZE：全家冷凍B2C
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C
HILIFEFREEZE：萊爾富冷凍B2C		 是
data.orders[i].data.LogisticsStatus string 10 物流狀態
create：建立
print：列印
unsigned：尚未簽收(狀態在1ship手動掃碼處理才有，若沒操作，則沒此狀態)
signed：已簽收
shipped：開始運送
delivered：抵達超商
received：取貨
problem：問題件
abnormal：異常(待處理)
nopick：未取貨
cancelled：取消
retdeliver：回到寄件店
return：已退貨(在B2C，在1ship手動掃碼處理才有，若沒操作，則沒此狀態)
destroy：銷毀(冷凍離島未取或C2C退貨未取都會被銷毀)		 是
data.orders[i].data.LogisticsStatusMsg string 200 物流狀態中文 是
data.orders[i].data.LogisticsSubStatus string 15 物流詳細狀態(第三方回傳) 是
data.orders[i].data.AbnormalProcessStatus int   abnormal異常狀態才有(目前只有關轉)
1：異常已解決
2：店鋪關轉
3：退貨寄件店鋪關轉		  
data.orders[i].data.ShipmentNo int   1ship號碼 是
data.orders[i].data.BookingNo string 13 託運單號(服務商) 是
data.orders[i].data.IsCollection string 1 是否貨到付款 N純寄送 Y代收 是
data.orders[i].data.ReceiverName string 20 收件人姓名 是
data.orders[i].data.ReceiverPhone string 10 收件人電話 是
data.orders[i].data.ReceiverEmail string 50 收件人Email  
data.orders[i].data.Measurement string 4 材積 S60 S90 S105 是
data.orders[i].data.OrderDate datetime   下單時間(Y-m-d H:i:s) 是
data.orders[i].data.ReservedNo string 20 保留編號 冷凍會回傳  
data.orders[i].data.CreateDate datetime   建立時間(Y-m-d H:i:s) 是
data.orders[i].data.PrintDate datetime   列印時間(Y-m-d H:i:s) 是
data.orders[i].data.UnsignedDate datetime   尚未簽收時間(Y-m-d H:i:s) 是
data.orders[i].data.SignedDate datetime   已簽收時間(Y-m-d H:i:s) 是
data.orders[i].data.ShippedDate datetime   開始運送時間(Y-m-d H:i:s) 是
data.orders[i].data.DeliveredDate datetime   抵達超商時間(Y-m-d H:i:s) 是
data.orders[i].data.ReceivedDate datetime   取貨時間(Y-m-d H:i:s) 是
data.orders[i].data.ProblemDate datetime   問題件時間(Y-m-d H:i:s) 是
data.orders[i].data.AbnormalDate datetime   異常時間(Y-m-d H:i:s) 是
data.orders[i].data.CancelledDate datetime   取消時間(Y-m-d H:i:s) 是
data.orders[i].data.NopickDate datetime   未取貨時間(Y-m-d H:i:s) 是
data.orders[i].data.RetdeliverDate datetime   回到寄件店時間(Y-m-d H:i:s) 是
data.orders[i].data.StoreID string 11 門市店號 是
data.orders[i].data.StoreName string 30 門市名稱 是
data.orders[i].data.StoreAddress string 60 門市地址 是
data.orders[i].data.TelNo string 10 門市號碼 是
data.orders[i].data.ShipAmount int   運費 是
data.orders[i].data.ReceiveAmount int   代收費 是
data.orders[i].data.CollectionAmount int   代收手續費 是
data.orders[i].data.SignedExpireDate datetime   最後出貨時間 是
data.orders[i].data.ExpectedPickupDateTimeStart datetime   預計上收時間起
FAMIFREEZE：全家冷凍B2C 才會回傳		  
data.orders[i].data.ExpectedPickupDateTimeEnd datetime   預計上收時間迄
FAMIFREEZE：全家冷凍B2C 才會回傳		  

批次查詢貨態 /v1/CargoStatusBatch

POST(FormData)

名稱 型態 字數限制 說明 必填
ShipmentNos string   1ship號碼，用逗號隔開，最多200筆 是

回傳(JSON)

名稱 型態 字數限制 說明 必傳
success int   執行結果 0成功 -1失敗 是
msg string   執行失敗說明，例如：
資料格式錯誤		  
data.orders array   success為0必傳  
data.orders[i].success int   單筆訂單執行結果 0成功 -1失敗 是
data.orders[i].msg string   執行失敗說明，例如：
上傳訂單失敗
查無此訂單		  
data.orders[i].data array     是
data.orders[i].data.ShipmentNo string 20 1ship號碼
(不論執行結果如何都會傳出)		 是(success -1也會)
data.orders[i].data.GoodsAmount int   訂單金額 是
data.orders[i].data.LogisticsType string   物流種類
FAMI：全家常溫B2C
FAMIC2C：全家常溫C2C
FAMIFREEZE：全家冷凍B2C
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C
HILIFEFREEZE：萊爾富冷凍B2C		 是
data.orders[i].data.LogisticsStatus string 10 物流狀態
create：建立
print：列印
unsigned：尚未簽收(狀態在1ship手動掃碼處理才有，若沒操作，則沒此狀態)
signed：已簽收
shipped：開始運送
delivered：抵達超商
received：取貨
problem：問題件
abnormal：異常(待處理)
nopick：未取貨
cancelled：取消
retdeliver：回到寄件店
return：已退貨(在B2C，在1ship手動掃碼處理才有，若沒操作，則沒此狀態)
destroy：銷毀(冷凍離島未取或C2C退貨未取都會被銷毀)		 是
data.orders[i].data.LogisticsStatusMsg string 200 物流狀態中文 是
data.orders[i].data.LogisticsSubStatus string 15 物流詳細狀態(第三方回傳) 是
data.orders[i].data.AbnormalProcessStatus int   abnormal異常狀態才有(目前只有關轉)
1：異常已解決
2：店鋪關轉
3：退貨寄件店鋪關轉		  
data.orders[i].data.OrderNumber string 20 訂單編號 是
data.orders[i].data.BookingNo string 13 託運單號(可用來查詢) 是
data.orders[i].data.IsCollection string 1 是否貨到付款 N純寄送 Y代收 是
data.orders[i].data.ReceiverName string 20 收件人姓名 是
data.orders[i].data.ReceiverPhone string 10 收件人電話 是
data.orders[i].data.ReceiverEmail string 50 收件人Email  
data.orders[i].data.Measurement string 4 材積 S60 S90 S105 是
data.orders[i].data.OrderDate datetime   下單時間(Y-m-d H:i:s) 是
data.orders[i].data.ReservedNo string 20 保留編號 冷凍會回傳  
data.orders[i].data.CreateDate datetime   建立時間(Y-m-d H:i:s) 是
data.orders[i].data.PrintDate datetime   列印時間(Y-m-d H:i:s) 是
data.orders[i].data.UnsignedDate datetime   尚未簽收時間(Y-m-d H:i:s) 是
data.orders[i].data.SignedDate datetime   已簽收時間(Y-m-d H:i:s) 是
data.orders[i].data.ShippedDate datetime   開始運送時間(Y-m-d H:i:s) 是
data.orders[i].data.DeliveredDate datetime   抵達超商時間(Y-m-d H:i:s) 是
data.orders[i].data.ReceivedDate datetime   取貨時間(Y-m-d H:i:s) 是
data.orders[i].data.ProblemDate datetime   問題件時間(Y-m-d H:i:s) 是
data.orders[i].data.AbnormalDate datetime   異常時間(Y-m-d H:i:s) 是
data.orders[i].data.CancelledDate datetime   取消時間(Y-m-d H:i:s) 是
data.orders[i].data.NopickDate datetime   未取貨時間(Y-m-d H:i:s) 是
data.orders[i].data.RetdeliverDate datetime   回到寄件店時間(Y-m-d H:i:s) 是
data.orders[i].data.StoreID string 11 門市店號 是
data.orders[i].data.StoreName string 30 門市名稱 是
data.orders[i].data.StoreAddress string 60 門市地址 是
data.orders[i].data.TelNo string 10 門市號碼 是
data.orders[i].data.ShipAmount int   運費 是
data.orders[i].data.ReceiveAmount int   代收費 是
data.orders[i].data.CollectionAmount int   代收手續費 是
data.orders[i].data.SignedExpireDate datetime   最後出貨時間 是
data.orders[i].data.ExpectedPickupDateTimeStart datetime   預計上收時間起
FAMIFREEZE：全家冷凍B2C 才會回傳		  
data.orders[i].data.ExpectedPickupDateTimeEnd datetime   預計上收時間迄
FAMIFREEZE：全家冷凍B2C 才會回傳		  

列印 /v1/PrintLabel

POST(FormData)

名稱 型態 字數限制 說明 必填
LogisticsType string   物流種類
FAMI：全家常溫B2C
FAMIC2C：全家常溫C2C
FAMIFREEZE：全家冷凍B2C
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C
HILIFEFREEZE：萊爾富冷凍B2C		 是
PrintType string   列印格式(不傳會依據後台設定)
A4-4：A4 (4個/頁) 物流單
A4-6：A4 (6個/頁)
1010-1：10cm * 10cm (1個/頁)
1014-1：10cm * 14cm (1個/頁)
1015-1：10cm * 15cm (1個/頁)
C2C：店到店C2C網頁		  
Measurement string 4 材積 S60 S90 S105 是
ShipmentNos string   1ship號碼，用逗號隔開，最多200筆 是

回傳(JSON)

名稱 型態 字數限制 說明 必傳
success int   執行結果 0成功 -1失敗 是
msg string   執行失敗說明，例如：
資料格式錯誤		  
data.url string   列印網址(請於2分鐘內抓取，逾期失效)  

選擇超商(前端跳轉) /v1/Map

POST(FormData)

名稱 型態 字數限制 說明 必填
LogisticsType string   物流種類
FAMI：全家常溫B2C
FAMIC2C：全家常溫C2C
FAMIFREEZE：全家冷凍B2C
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C
HILIFEFREEZE：萊爾富冷凍B2C		 是
Island int   是否出現離島店鋪
0：不出現
1：出現		 是
ServerReplyURL string 100 選完地圖後回來的網址 是
ExtraData string 100 資料傳遞  
RcvOldStoreID string 11 帶入門市店號後回直接到選完地圖確認頁(只適用於LogisticsType為FAMIFREEZE：全家冷凍B2C)  

跳轉回傳(FormData)

名稱 型態 字數限制 說明 必傳
LogisticsType string   物流種類
FAMI：全家常溫B2C
FAMIC2C：全家常溫C2C
FAMIFREEZE：全家冷凍B2C
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C
HILIFEFREEZE：萊爾富冷凍B2C		 是
MerchantID string 8 得知身分用 是
CVSStoreID string 11 門市店號 是
CVSStoreName string 30 門市名稱 是
CVSStoreAddress string 60 門市地址 是
CVSStorePhone string 10 門市號碼 是
CVSStoreZip string 5 取件門市郵遞區
號，只有下列會傳出
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C
HILIFEFREEZE：萊爾富冷凍B2C		  
CVSReservedNo string 20 保留編號，只有下列會傳出
FAMIFREEZE：全家冷凍B2C
HILIFEFREEZE：萊爾富冷凍B2C		  
ExtraData string 100 資料傳遞回傳  

取得所有店鋪資料 /v1/AllStore

超商每日店鋪資料只會傳送一次，建議傳送時間+10分鐘在抓取資料即可

物流種類 時間
FAMI
FAMIC2C		 17:00
FAMIFREEZE 07:30
HILIFE
HILIFEC2C		 01:30
HILIFEFREEZE 01:30

GET

名稱 型態 字數限制 說明 必填
LogisticsType string   物流種類
FAMI：全家常溫B2C
FAMIC2C：全家常溫C2C
FAMIFREEZE：全家冷凍B2C
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C
HILIFEFREEZE：萊爾富冷凍B2C		 是

跳轉回傳(json)

名稱 型態 字數限制 說明 必傳
success int   執行結果 0成功 -1失敗 是
msg string   執行失敗說明，例如：
資料格式錯誤		  
data.info array   success為0必傳  
data.info[i].StoreID string 11 門市店號 是
data.info[i].StoreName string 30 門市名稱 是
data.info[i].StoreAddress string 60 門市地址 是
data.info[i].TelNo string 10 門市號碼 是

關轉店鋪重選 /v1/ReselectStore

POST

名稱 型態 字數限制 說明 必填
LogisticsType string   物流種類
FAMI：全家常溫B2C
FAMIC2C：全家常溫C2C
HILIFE：萊爾富常溫B2C
HILIFEC2C：萊爾富常溫C2C		 是
ShipmentNo int   1ship號碼 是
StoreID string 11 門市店號 是

回傳(JSON)

名稱 型態 字數限制 說明 必傳
success int   執行結果 0成功 -1失敗 是
msg string   執行失敗說明，例如：
資料格式錯誤