FamilyBulk V2.4

全家大宗物流流程說明

取得店鋪資料並成立訂單取號

導向到選擇物流服務，取得店鋪相關資訊

完善訂單資料後組成JSON字串Post到建立物流單

建立訂單成功後帶入指定資料打向獲取出貨單取得配送編號

取得配送編號後至列印全家大宗物流網址獲取物流單標籤

重新取號

需等物流驗收後且不能是已取貨的狀態才能重新取號

配對新的出貨單號後仍要到列印全家大宗物流列印新標籤進行大宗物流出貨

建立退貨通物流單

取得退貨便代號，消費者需於7日內進行完成退貨寄件

FamiBulk流程圖

famibulkflow

FamiBulk退貨流程圖

famibulkreturnflow

FamilyBulk API

網址連結

正式: https://logistic.paynow.com.tw
測試: https://testlogistic.paynow.com.tw

1. 選擇物流服務

說明

使用者在此頁面選擇取貨門市，選擇完畢後回傳門市資訊至帶入的回傳網址

傳遞方式：Http POST method

API URL：/Member/Order/Choselogistics

Request

參數	名稱	型態	長度	必須	備註
user_account	商家主帳號	string	10	Y
orderno	訂單編號	string	27	N
apicode	商家api密碼	string	30	Y	請以TripleDESEncoding加密後傳送附錄
Logistic_serviceID	物流服務ID	string	2	Y	04:全家大宗物流
returnUrl	回傳網址	string	200	Y	回傳店號網址

Response

參數	名稱	型態	長度	必須	備註
orderno	商家訂單編號	string	20	Y	如有帶入訂單編號則回傳訂單編號
service	物流服務	string	2	Y	04:全家大宗物流
storeaddress	店址	string	150	Y
storename	店名	string	30	Y
storeid	店ID	string	10	Y

2. 建立物流訂單

說明

建立物流訂單

傳遞方式：Http POST method application/x-www-form-urlencoded

API URL：/api/Orderapi/Add_Order

Request

參數	名稱	型態	長度	必須	備註
JsonOrder	物流單資料	string		Y	資料組成JSON字串以TripleDESEncoding加密後UrlEncode傳送附錄

JsonOrder Content

參數	名稱	型態	長度	必須	備註
user_account	商家主帳號	string	10	Y
apicode	商家api密碼	string	30	Y
Logistic_service	使用的物流服務	string	2	Y	04: 全家大宗物流
OrderNo	商家訂單編號	string	27	Y	限英文與數字
DeliverMode	取貨是否付款	string	2	Y	01:取貨付款 02:取貨不付款
TotalAmount	總金額	string	5	Y	正整數且金額不可大於20000
Remark	備註	string	200	Y	若不填入值請填空字串
Description	單號描述	string	50	Y	若不填入值請填空字串
EC	EC平台	string	50	N
receiver_storeid	取件店號	string	30	Y
receiver_storename	取件店名	string	100	Y
return_storeid	退件店號	string	6	Y	若不填入值請填空字串
Receiver_Name	收件人姓名	string	10	Y	中文最多10個字、英文20個字
Receiver_Phone	收件人手機	string	10	Y
Receiver_Email	收件人EMAIL	string	100	Y
Receiver_address	收件人地址	string	150	Y	請輸入取件店址
Sender_Name	寄件人姓名	string	10	Y	請填空字串將會自動帶入立吉富
Sender_Phone	寄件人手機	string	10	Y	請填空字串將會自動帶入0900000000
Sender_Email	寄件人EMAIL	string	100	Y
Sender_address	寄件人地址	string	150	Y	如不填入請填空字串
PassCode	傳遞碼	string		Y	以下參數值依序組合起來成一段字串(不包含+號) : user_account + OrderNo + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值附錄
Deadline	預定出貨天數	int		Y	預定出貨日須為1~7之間的數字預定出貨日=建立物流單日 + DeadLine Ex:建立物流單日期為2021/03/14，Deadline為3，則預定出貨日為2021/3/17

Response

NewOrderReturn Content

參數	名稱	型態	長度	必須	備註
Status	狀態	string	1	Y	S:成功 F:失敗
LogisticNumber	PayNow物流單號	string	20	Y
LogisticService	物流服務名稱	string		Y	全家大宗物流
LogisticServiceID	物流服務代碼	string	2	Y	04:全家大宗物流
ErrorMsg	錯誤訊息	string		Y	成功則為null
ReturnMsg	回傳訊息	string		Y
orderno	商家訂單編號	string	27	Y

Objec Example

Request Object

{
  "user_account":"28229955",
  "apicode":"12345678",
  "Logistic_service":"04",
  "OrderNo":"211213121814",
  "DeliverMode":"02",
  "TotalAmount":"200",
  "Remark":"",
  "Description":"test",
  "receiver_storeid":"017221",
  "receiver_storename":"全家太平新興中店",
  "return_storeid":"",
  "Receiver_Name":"收件測",
  "Receiver_Phone":"0912345678",
  "Receiver_Email":"123@paynow.com.tw",
  "Receiver_address":"新北市三重區力行路二段158號160號",
  "Sender_Name":"寄件測",
  "Sender_Phone":"0900000000",
  "Sender_Email":"test@paynow.com.tw",
  "Sender_address":"",
  "PassCode":"1E486B6EF04B8DE4633C16020CDA715454401621",
  "Deadline":1
}

Response Object

{
  "Status":"S",
  "LogisticNumber":"MIJA002FB22112130001",
  "LogisticService":"全家大宗物流",
  "LogisticServiceID":"04",
  "ReturnMsg":"",
  "orderno":"211213121814",
  "ErrorMsg":null
}

3. 物流貨態回傳

說明

商家接收物流貨態，更新貨態時由PayNow傳送訂單貨態資料給商家

傳遞方式：Http Post method

Request

參數	名稱	型態	長度	必須	備註
orderno	商家自訂編號	string	30	Y
OriginOrderno	商家原始自訂單號	string	27	Y
PayNowLogisticCode	物流代碼	string	4	Y
Detail_Status_Description	物流狀態描述	string	2	Y
paymentno	物流商託運單號	string		Y
StoreDate	到店日期	string		N	若代碼為5000/5001 商品實際到店日期
StoreTime	到店時間	string		N	若代碼為5000/5001 商品實際到店時間

4. 獲取出貨單號

說明

獲取物流出貨單號(配送編號)

傳遞方式：Http POST method

API URL：/api/FamiB2COrder/ShipFamiB2Cpaymentno

Request

參數	名稱	型態	長度	必須	備註
JsonOrder	物流單資料	string		Y	資料組成JSON字串以TripleDESEncoding加密後UrlEncode傳送附錄

JsonOrder Content

參數	名稱	型態	長度	必須	備註
user_account	商家主帳號	string	10	Y
apicode	商家api密碼	string	30	Y
PassCode	傳遞碼	string		Y	以下參數值依序組合起來成一段字串(不包含+號)：user_account + apicode並使用sha-1雜湊函數取得組合字串的雜湊值附錄
ShipList	訂單列表			Y	子JsonString，Object Array組成

ShipList Content

參數	名稱	型態	長度	必須	備註
LogisticNumber	Paynow物流單號	string	20	Y
sno	物流單序號	string		Y	固定為1

Response

ShipFamiB2CReturn Object Array

參數	名稱	型態	長度	備註
LogisticNumber	PayNow物流單號	string	20
sno	物流單序號	string
paymentno	出貨單號	string		配送編號
ErrorMsg	錯誤訊息	string		如發生錯誤則此屬性有值，其他屬性空值。

Objec Example

Request Object

{
  "user_account":"28229955",
  "apicode":"12345678",
  "PassCode":"625B528740B1860CA5392E2CA2B577066596A160",
  "ShipList":
    [
      {
        "LogisticNumber":"MIJA0027B22112100002",
        "sno":"1"
      }
    ]
  }

Response Object

//多筆資料型態
[
  {
    "LogisticNumber":"MIJA0027B22112100002",
    "sno":"1",
    "paymentno":"82900502030",
    "ErrorMsg":null
  }
]

5. 列印全家大宗(物流標籤)

說明

列印全家大宗物流單

傳遞方式：Http POST method

API URL：/Member/Order/PrintFamiB2CLabel

Request

參數	名稱	型態	長度	必須	備註
LogisticNumbers	Paynow物流單號組成的字串	string		Y	Paynow物流單號+底線+物流單子序號多筆之間用 , 相隔 EX:ABCD0017B21903001221_1, ABCD0017B21903001270_1

Response

回傳列印物流標籤畫面

6. 取消物流單

說明

將該張物流單更改為無效訂單，若為出貨中大宗訂單無法使用功

傳遞方式：Http DELETE method application/x-www-form-urlencoded

API URL：/api/Orderapi/CancelOrder

Request

參數	名稱	型態	長度	必須	備註
LogisticNumber	Paynow物流單號	string	20	Y
sno	物流單序號	int		Y
PassCode	傳遞碼	string		Y	以下參數值依序組合成一段字串(不包含+號)user_account + OrderNo + TotalAmount + apicode並使用SHA-1雜湊函數取得組合字串的雜湊值附錄

Response

參數	名稱	型態	長度	必須	備註
		string		Y	純字串 S成功回傳: S:訂單已取消失敗回傳 F:訂單取消失敗失敗原因: 失敗原因

7. 查詢物流單(PayNow物流單號)

說明

根據PayNow物流單號查詢物流單資訊

傳遞方式：Http GET method

API URL：/api/Orderapi/Get_Order_Info

Request

參數	名稱	型態	長度	必須	備註
LogisticNumber	PayNow物流單號	string	20	Y
sno	物流單序號	int		Y	固定為1

Response

參數	名稱	型態	長度	必須	備註
LogisticNumber	PayNow物流單號	string	20	Y
sno	物流單序號	string		Y
orderno	商家訂單編號	string	30	Y
Logistic_Serviece	物流服務	string	2	Y	04全家大宗物流 14:全家大宗退貨通
Status	狀態	string	1	Y	0：成立中訂單 1：無效訂單
Delivery_Status	物流狀態	string	2	Y	流程狀態描述
PayNowLogisticCode	物流代碼	string	4	Y	PayNow物流代碼
Detail_Status_Description	物流代碼描述	string		Y	PayNow物流代碼詳細資訊
paymentno	物流商託運單號	string		Y
ErrorMsg	錯誤訊息	string		Y	Null則為查詢成功

Objec Example

Request Object

{
  "LogisticNumber":"MIJA0027B22112100002",
  "sno":"1",
}

Response Object

{
  "LogisticNumber":"MIJA002FR22112156425",
  "orderno":"211215145423",
  "Logistic_Serviece":"24",
  "Status":"0",
  "Delivery_Status":"等待寄件",
  "PayNowLogisticCode":"0000",
  "Detail_Status_Description":"等待寄件",
  "sno":"1",
  "ErrorMsg":null,
  "paymentno":"11000094930"
} 

8. 查詢物流單(商家訂單編號)

說明

查詢物流單(商家訂單編號)

傳遞方式：Http GET method

API URL：/api/Orderapi/Get_Order_Info_orderno

Request

參數	名稱	型態	長度	必須	備註
orderno	商家訂單編號	string	30	Y
user_account	商家主帳號	string	10	Y
sno	物流單序號	int		Y	固定為1

Response

參數	名稱	型態	長度	必須	備註
LogisticNumber	PayNow物流單號	string	20	Y
sno	物流單序號	string		Y
orderno	商家訂單編號	string	30	Y
Logistic_Serviece	物流服務	string	2	Y	04全家大宗物流 14:全家大宗退貨通
Status	狀態	string	1	Y	0:成立中訂單 1:無效訂單
Delivery_Status	物流狀態	string	2	Y	流程狀態描述
PayNowLogisticCode	物流代碼	string	4	Y	PayNow物流代碼
Detail_Status_Description	物流代碼描述	string		Y	PayNow物流代碼詳細資訊
paymentno	物流商託運單號	string		Y
ErrorMsg	錯誤訊息	string		Y	Null則為查詢成功

Objec Example

Request Object

{
  "orderno":"1630206584255",
  "user_account":"28229955",
  "sno":"1",
}

Response Object

{
     "LogisticNumber":"MIJA002FR22112156425",
     "orderno":"211215145423",
     "Logistic_Serviece":"24",
     "Status":"0",
     "Delivery_Status":"等待寄件",
     "PayNowLogisticCode":"0000",
     "Detail_Status_Description":"等待寄件",
     "sno":"1",
     "ErrorMsg":null,
     "paymentno":"11000094930"
} 

9. 重新取號

說明

依商家原有訂單資料進行重新取號(配送編號)
重新取號規則
1. 已獲取出貨單號且訂單狀態為成立中，且買家尚未取貨
2. (貨態為1000:訂單上傳中、8000:買家已取件，無法重新取號)

傳遞方式：Http POST method application/x-www-form-urlencoded

API：URL/api/Orderapi/ReNewOrder

Request

參數	名稱	型態	長度	必須	備註
JsonOrder	物流單資料	string		Y	以下資料組成Object後轉換JsonString以TripleDESEncoding加密後urlencode傳送附錄

Json Content

參數	名稱	型態	長度	必須	備註
user_account	商家主帳號	string	10	Y
LogisticNumber	Paynow物流單號	string	20	Y
sno	物流單序號	int		Y
OrderNo	商家訂單編號	string	27	Y	商家原始訂單編號
TotalAmount	訂單總金額	string	5	Y
apicode	商家api密碼	string	30	Y
PassCode	傳遞碼	string		Y	以下參數值依序組合成一段字串(不包含+號)user_account + OrderNo + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值附錄

Response

參數	名稱	型態	長度	必須	備註
Status	狀態	string	1	Y	S:成功 F:失敗
LogisticNumber	PayNow物流單號	string	20	Y
OrderNo	商家原始訂單編號	string	27	Y
sno	物流單序號	int		Y
paynoworderno	新訂單編號	string	30	Y	商家原始訂單編號
paymentno	物流商貨運編號	string		Y	重新取號後新的物流商貨運編號
ErrorMsg	錯誤訊息	string		Y	成功則為null

Objec Example

Request Object

{
  "LogisticNumber":"MIJA0027B22112100002",
  "OrderNo":"211210165125",
  "apicode":"12345678",
  "TotalAmount":"200",
  "user_account":"28229955",
  "PassCode":"4CF47FD844DF64C5D0FBF8DD134708B55ABE208B",
  "sno":"1"
}

Response Object

{
  "LogisticNumber":"MIJA0027B22112100002",
  "OrderNo":"211210165125",
  "paynoworderno":"211210165125",
  "sno":"1",
  "paymentno":"82900502031",
  "Status":"S",
  "ErrorMsg":null
}

10. 更新物流訂單

說明

更改全家大宗資料，並自動重新取號
出貨中須等隔天訂單上傳成功後才能重新取號(貨態 1000:訂單上傳中、8000:買家已取件，無法更改全家大宗資料與重新取號)

傳遞方式:Http PUT method

API URL:/api/FamiB2COrder/UpdateFamiB2COrder

Request

參數	名稱	型態	長度	必須	備註
UpdateBulkFamiOrder	物流單資料	string		Y	請帶入UpdateBulk711Order JSON字串

UpdateBulkFamiOrder 主物件

參數	名稱	型態	長度	必須	備註
LogisticNumber	Paynow物流單號	string	20	Y
sno	物流單序號	int		Y
PassCode	傳遞碼	string		Y	將以下參數值依序組合起來成一段字串(不包含+號) : user_account + Orderno + TotalAmount + apicode並使用SHA-1雜湊函數取得組合字串的雜湊值附錄
receiver_storeid	取件店號	string	6	N
receiver_storename	取件店名	string	100	N
Receiver_Name	收件人姓名	string	10	N	長度限制須至少包含兩個中文字或4個英文字，最多五個中文字或10個英文字不得包含 , 號
Receiver_Phone	收件人電話	string	10	N

Response

參數	名稱	型態	長度	必須	備註
Status	狀態	string	1	Y	S:成功 F:失敗
LogisticNumber	PayNow物流單號	string	20	Y
OrderNo	商家原始訂單編號	string	27	Y
sno	物流單序號	int		Y
paynoworderno	新訂單編號	string	30	Y	商家原始訂單編號
paymentno	物流商貨運編號	string		Y	重新取號後新的物流商貨運編號
ErrorMsg	錯誤訊息	string		Y	成功則為null

11. 建立退貨物流單

說明

建立退貨物流單

傳遞方式：Http POST method application/x-www-form-urlencoded

API URL：/api/Orderapi/ReturnPaymentno

Request

參數	名稱	型態	長度	必須	備註
JsonOrder	物流單資料	string		Y	資料組成JSON字串以TripleDESEncoding加密後UrlEncode傳送附錄

JsonOrder Content

參數	名稱	型態	長度	必須	備註
user_account	商家主帳號	string	10	Y
apicode	商家api密碼	string	30	Y
LogisticNumber	Paynow物流單號	string	20	Y	要進行退貨的Paynow物流單號
LogisticServiceID	物流服務代碼	string	2	Y	04: 全家大宗物流
PassCode	傳遞碼	string		Y	以下參數值依序組合起來成一段字串(不包含+號)：user_account + LogisticNumber + apicode並使用sha-1雜湊函數取得組合字串的雜湊值附錄

Response

參數	名稱	型態	長度	必須	備註
Status	狀態	string	1	Y	S:成功 F:失敗
LogisticNumber	PayNow物流單號	string	20	Y	退貨便的PayNow物流單號
LogisticService	物流服務	string		Y	全家大宗退貨通
LogisticServiceID	物流服務代碼	string		Y	14
OrderNo	商家原始訂單編號	string	27	Y	申請退貨便的 PayNow 物流單號
sno	物流單序號	int		Y
paynoworderno	新訂單編號	string	12	Y	退貨通配送編號:貨運編號(11碼)+檢核碼(1 碼)請於FamiPort機台輸入並列印物流單(共12碼)其他情境請使用前11碼查詢
paymentno	物流商貨運編號	string		Y	重新取號後新的物流商貨運編號
ErrorMsg	錯誤訊息	string		Y	成功則為null

貨態代碼

	貨態代碼	貨態描述
全家大宗	0000	訂單已成立等待出貨
	1000	訂單檔案上傳中
	1050	物流訂單上傳成功
	2130	檔名錯誤
	2131	欄位值為空
	2132	欄位值溢位
	2133	資料錯誤
	2134	訂單重複
	4000	進驗成功
	4019	物流中心未收到貨
	4031	商品破損退貨中
	4032	商品超才退貨中
	4040	條碼資料錯誤
	4067	小物流遺失
	4068	門市遺失
	4069	包裝廠不良包裝廠不良 (滲漏 )
	4070	門市反應商品包裝不良(滲漏)
	4071	門市關店
	4072	條碼資料重複
	4073	7日內未寄件單號失效
	4074	貨物進店後發生異常提早退貨
	5000	取件門市配達
	6002	待退貨請盡速取件
	6004	商品退回物流中心
	8000	買家已取件
	8001	退貨成功
	8010	買家已取件-代收金額錯誤
	8020	買家已取件商品有誤
	9411	貨態停滯
全家退貨便	0001	訂單已成立等待退貨
	0101	商品已到寄件門市
	4000	進驗成功
	4009	物流中心未收到貨
	4031	商品破損退貨中
	4032	商品超才退貨中
	4040	條碼資料錯誤
	4067	小物流遺失
	4068	門市遺失
	4069	包裝廠不良包裝廠不良 (滲漏 )
	4070	門市反應商品包裝不良(滲漏)
	4071	門市關店
	4072	條碼資料重複
	4073	7日內未寄件單號失效
	4074	貨物進店後發生異常提早退貨
	8100	賣家已取件
	9411	貨態停滯

貨態代碼流變動程
一般出貨流程(成功取件)
1000->1050->4000->5000->8000
一般出貨流程(退貨成功)
1000->1050->4000->5000->6004->8001

FamilyBulk V2.4

全家大宗物流流程說明

取得店鋪資料並成立訂單取號

重新取號

建立退貨通物流單

FamilyBulk API

網址連結

1. 選擇物流服務

2. 建立物流訂單

3. 物流貨態回傳

4. 獲取出貨單號

5. 列印全家大宗(物流標籤)

6. 取消物流單

7. 查詢物流單(PayNow物流單號)

8. 查詢物流單(商家訂單編號)

9. 重新取號

1. 已獲取出貨單號且訂單狀態為成立中，且買家尚未取貨

2. (貨態為1000:訂單上傳中、8000:買家已取件，無法重新取號)

10. 更新物流訂單

11. 建立退貨物流單

FamilyBulk V2.4

全家大宗物流流程說明​

取得店鋪資料並成立訂單取號​

重新取號​

建立退貨通物流單​

FamilyBulk API​

網址連結​

1. 選擇物流服務​

2. 建立物流訂單​

3. 物流貨態回傳​

4. 獲取出貨單號​

5. 列印全家大宗(物流標籤)​

6. 取消物流單​

7. 查詢物流單(PayNow物流單號)​

8. 查詢物流單(商家訂單編號)​

9. 重新取號​

1. 已獲取出貨單號且訂單狀態為成立中，且買家尚未取貨​

2. (貨態為1000:訂單上傳中、8000:買家已取件，無法重新取號)​

10. 更新物流訂單​

11. 建立退貨物流單​

全家大宗物流流程說明

取得店鋪資料並成立訂單取號

重新取號

建立退貨通物流單

FamilyBulk API

網址連結

1. 選擇物流服務

2. 建立物流訂單

3. 物流貨態回傳

4. 獲取出貨單號

5. 列印全家大宗(物流標籤)

6. 取消物流單

7. 查詢物流單(PayNow物流單號)

8. 查詢物流單(商家訂單編號)

9. 重新取號

1. 已獲取出貨單號且訂單狀態為成立中，且買家尚未取貨

2. (貨態為1000:訂單上傳中、8000:買家已取件，無法重新取號)

10. 更新物流訂單

11. 建立退貨物流單