FamilyFreezingBulkB2C V2.6

全家大宗(冷凍)物流流程說明

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

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

(會將店號、店名、店址、物流服務、訂單編號、保留編號、出貨日期回傳至回傳店號網址)

(選取店鋪後3小時會暫留店鋪空間，3小時內需回傳店鋪空間確認，進行保留)

保留店鋪後，完善訂單資料後組成JSON字串Post到建立物流單

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

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

請依電子地圖回傳的出貨日期進行出貨

(若於出貨日期未進行出貨且已確認店鋪空間，請取消店鋪空間保留)

訂單需在電子地圖回傳出貨日期前一天建立完成並取完物流單號、列印標籤完畢

重選店鋪:

使用於同筆訂單編號更改店鋪資訊，若確認過店鋪空間需先取消

重選完的保留編號需在進行保留確認，確認完成後才可進行列印標籤

FamiFreezingBulkB2C流程圖

famifreezingC2Cflow

FamiFreezingBulkB2C 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	24:全家大宗物流(冷凍)
returnUrl	回傳網址	string	200	Y	回傳店號網址
Length	長	string	2	Y	單位為公分材積限制:依申請材積分別可帶入 S60:長+寬+高<60 / S105:長+寬+高<105
Wide	寬	string	2	Y	單位為公分材積限制:依申請材積分別可帶入 S60:長+寬+高<60 / S105:長+寬+高<105
High	高	string	2	Y	單位為公分材積限制:依申請材積分別可帶入 S60:長+寬+高<60 / S105:長+寬+高<105
Weight	重量	string	6	Y	單位為公克，如不填入請填空字串
StartDate	出貨日起	string	10	Y	格式: yyyy-MM-dd 如不填入請填空字串
EndDate	出貨日迄	string	10	Y	格式: yyyy-MM-dd 如不填入請填空字串
Ecplateform	回傳網址	string	200	Y

Response

參數	名稱	型態	長度	必須	備註
orderno	商家訂單編號	string	20	Y	如有帶入訂單編號則回傳訂單編號
service	物流服務	string	2	Y	24:全家大宗物流(冷凍)
storeaddress	店址	string	150	Y
storename	店名	string	30	Y
storeid	店ID	string	10	Y
ReservedNo	保留編號	string	20	Y	預約店鋪空間的編號，若需保留空間請於3小時內向店鋪空間保留API進行確認
ShipDate	出貨日期	string		Y	格式：yyyy-MM-dd 請於此日期前建立訂單並出貨

2. 店鋪空間保留確認/取消

說明

向超商保留或取消存放冷凍商品的空間
取消店鋪空間後未重選店對應的訂單將無法配送
使用情境
1. 新增訂單前需先保留空間才可成功建立訂單
2. 重選店舖若有保留過需先取消，取得新保留編號後需再保留新編號
3. 最終未出貨訂單需取消

傳遞方式：Http POST method

API URL：/api/FamiFreezingB2C/UpSpaceConfirm

Request

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

JsonOrder Content

參數	名稱	型態	長度	必須	備註
user_account	商家主帳號	string	10	Y
apicode	商家api密碼	string	30	Y
ReservedNo	保留編號	string	20	Y
Flag	Flag	string	1	Y	0:保留 1:取消

Response

參數	名稱	型態	長度	必須	備註
	回傳字串	string	10	Y	成功回傳：S, 失敗回傳：F,錯誤訊息

3. 建立物流訂單

說明

建立物流訂單

傳遞方式：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	24: 全家大宗物流(冷凍)
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雜湊函數取得組合字串的雜湊值附錄
ReservedNo	保留編號	string	20	Y	電子地圖回傳保留編號

Response

NewOrderReturn Content

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

Objec Example

Request Object

{
  "user_account":"28229955",
  "apicode":"12345678",
  "Logistic_service":"24",
  "OrderNo":"211214173255",
  "DeliverMode":"02",
  "TotalAmount":"200",
  "Remark":"",
  "Description":"test",
  "receiver_storeid":"015946",
  "receiver_storename":"全家三重新正店",
  "return_storeid":"",
  "Receiver_Name":"收件測",
  "Receiver_Phone":"0912345678",
  "Receiver_Email":"123@paynow.com.tw",
  "Receiver_address":"新北市三重區中正南路184號1樓",
  "Sender_Name":"寄件測",
  "Sender_Phone":"0900000000",
  "Sender_Email":"test@paynow.com.tw",
  "Sender_address":"",
  "PassCode":"3C14D470EDB3F8541177A9FC0DC98842ED14D4C2",
  "ReservedNo":"21120300000000518048",
}

Response Object

{
  "Status":"S",
  "LogisticNumber":"MIJA002FF22112140001",
  "LogisticService":"全家大宗物流冷凍",
  "LogisticServiceID":"24",
  "ReturnMsg":"",
  "orderno":"211214173255",
  "ErrorMsg":null
}

4. 物流貨態回傳

說明

商家接收物流貨態，更新貨態時由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 商品實際到店時間

5. 獲取出貨單號

說明

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

傳遞方式：Http POST method

API URL：/api/711FreezingB2C/Ship711B2Cpaymentno

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	訂單列表	Array		Y	子JsonString，Object Array組成

ShipList Content

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

Response

ShipBulk711Return 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":"MIJA002FF22112140001",
      "sno":"1"
      }
    ]
}

Response Object

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

6. 列印全家大宗冷凍(物流標籤)

說明

列印全家大宗冷凍物流單

傳遞方式：Http POST method

API URL：/Member/Order/PrintFamiFreezingB2CLabel

Request

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

Response

回傳列印物流標籤畫面

7. 更新物流訂單

說明

更改未出貨的訂單資料，請在未完成出貨程序前使用

傳遞方式：Http PUT method

API URL：/api/FamiFreezingB2C/UpdateB2CFamiOrder

Request

參數	名稱	型態	長度	必須	備註
UpdateOrder	物流單資料	string		Y	以下資料組成Object後轉換JsonString

UpdateOrder Content

參數	名稱	型態	長度	必須	備註
LogisticNumber	Paynow物流單號	string	20	Y
sno	物流單序號	int		Y
PassCode	傳遞碼	string		Y	以下參數值依序組合成一段字串(不包含+號)user_account + OrderNo + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值附錄
Receiver_Name	收件人姓名	string	10	N	中文最多10個字、英文20個字且不可包含特殊符號
Receiver_Phone	收件人電話	string	10	N	須為台灣手機格式

Response

參數	名稱	型態	長度	必須	備註
	回傳字串	string	3	Y	成功回傳:S 失敗回傳:F,錯誤訊息

8. 重選店鋪

說明

更換訂單的取件門市，有保留店鋪空間需先進行取消，取得回傳資料後需再進行保留
使用者在此頁面選擇取貨門市，選擇完畢後回傳重選的門市資訊至帶入的回傳網址，若已取過配送編號將同時取得新的配送編號
此API適用於建立物流單後或選擇物流服務API有帶入訂單編號
貨態1000:訂單上傳中，無法重選店鋪

傳遞方式：Http POST method

API URL：/Member/Order/ReStoreID

Request

參數	名稱	型態	長度	必須	備註
user_account	商家主帳號	string	10	Y
apicode	商家api密碼	string	30	Y
Logistic_serviceID	使用的物流服務	string	2	Y	24: 全家大宗物流(冷凍)
returnUrl	回傳網址	string	200	Y	回傳店號網址
Length	長	string	2	Y	單位為公分材積限制:依申請材積分別可帶入 S60:長+寬+高<60 / S105:長+寬+高<105
Wide	寬	string	2	Y	單位為公分材積限制:依申請材積分別可帶入 S60:長+寬+高<60 / S105:長+寬+高<105
High	高	string	2	Y	單位為公分材積限制:依申請材積分別可帶入 S60:長+寬+高<60 / S105:長+寬+高<105
Weight	重量	string	6	Y	單位為公克，如不填入請填空字串
StartDate	出貨日起	string	10	Y	格式: yyyy-MM-dd 如不填入請填空字串
EndDate	出貨日迄	string	10	Y	格式: yyyy-MM-dd 如不填入請填空字串
Ecplateform	回傳網址	string	200	Y
ReservedNo	保留編號	string	200	Y	請先進行保留取消，取消後此編號將無法使用
LogisticNumber	PayNow物流單號	string	20	Y	如此保留編號已建立過物流單請帶入物流單號

Response

參數	名稱	型態	長度	必須	備註
orderno	商家訂單編號	string	20	Y
service	物流服務	string	2	Y	24:全家大宗物流(冷凍)
storeaddress	店址	string	150	Y
storename	店名	string	30	Y
storeid	店ID	string	10	Y
ReservedNo	保留編號	string	20	Y	預約店鋪空間的編號，若需保留空間請於3小時內向店鋪空間保留API進行確認
ShipDate	出貨日期	string	10	Y	格式：yyyy-MM-dd 請於此日期前建立訂單並出貨
paymentno	物流商貨運編號	string		Y	如要號過有值

9. 查詢物流單(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	24:全家大宗物流(冷凍)
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"
} 

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

說明

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

傳遞方式：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	24:全家大宗物流(冷凍)
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"
} 

11. 查詢商家材積

說明

查詢目前商家申請的材積

傳遞方式：Http GET method

API URL：/api/FamiFreezingB2C/GetFamiFreezingVolume

Request

參數	名稱	型態	長度	必須	備註
user_account	商家主帳號	string	12	Y
sonid	商家分店代號	string	3	Y

Response

參數	名稱	型態	長度	必須	備註
	回傳字串	string	3	Y	成功回傳S60/S105/ S60- S105 失敗回傳錯誤訊息

12. 取消物流單

說明

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

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

API URL：/api/Orderapi/CancelOrder

Request

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

Response

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

FamiFreezingBulkB2C物流貨態代碼

貨態代碼

貨態代碼	貨態描述
0000	訂單已成立等待出貨
1000	訂單檔案上傳中
1050	物流訂單上傳成功
2130	檔名錯誤
2131	欄位值為空
2132	欄位值溢位
2133	資料錯誤
2134	訂單重複
2135	取件店閉店
4000	進驗成功
4001	物流商出貨
4007	商品捆包已退
4005	商品多標籤
4031	商品破損退貨中
4032	商品超才退貨中
4039	無標籤
4040	條碼資料錯誤
4041	貨件破損已退
4042	包裝凹折已退
4043	冷凍件已退
4044	到貨後訂單刪除
4045	貨件曾重複出貨
4046	禁運品已退
4061	商品遺失
4063	包裹異常不配送
4067	小物流遺失
4068	門市遺失
4069	包裝廠不良包裝廠不良 (滲漏 )
4070	門市反應商品包裝不良(滲漏)
4071	門市關店
4072	條碼資料重複
4073	7日內未寄件單號失效
4074	貨物進店後發生異常提早退貨
4533	商品超重
4633	超重需退貨
4703	貨件銷毀
4803	商品捆包待廠商回覆
4805	商品多標籤待廠商回覆
4832	超材需退貨
4839	無標籤待廠商回覆
4840	條碼資料錯誤待廠商回覆
4841	貨件破損待廠商回覆
4842	包裝凹折待廠商回覆
4843	誤進冷凍件需退貨
4844	到貨時訂單刪除待廠商回覆
4845	貨件曾重複出貨待廠商回覆
4846	禁運品需退貨
4863	包裹異常不配送待廠商回覆
4869	貨件濕損待廠商回覆
4871	門市關店待廠商回覆
4872	條碼資料重複待廠商回覆
4941	貨件破損進入賠償程序
4963	異常已個案賠償
5000	取件門市配達
6002	待退貨請盡速取件
6004	商品退回物流中心
8000	買家已取件
8001	退貨成功
8010	買家已取件-代收金額錯誤
8020	買家已取件商品有誤
9411	貨態停滯

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

FamilyFreezingBulkB2C V2.6

全家大宗(冷凍)物流流程說明

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

重選店鋪:

FamiFreezingBulkB2C API

網址連結

1. 選擇物流服務

2. 店鋪空間保留確認/取消

1. 新增訂單前需先保留空間才可成功建立訂單

2. 重選店舖若有保留過需先取消，取得新保留編號後需再保留新編號

3. 最終未出貨訂單需取消

3. 建立物流訂單

4. 物流貨態回傳

5. 獲取出貨單號

6. 列印全家大宗冷凍(物流標籤)

7. 更新物流訂單

8. 重選店鋪

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

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

11. 查詢商家材積

12. 取消物流單

FamiFreezingBulkB2C物流貨態代碼

FamilyFreezingBulkB2C V2.6

全家大宗(冷凍)物流流程說明​

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

重選店鋪:​

FamiFreezingBulkB2C API​

網址連結​

1. 選擇物流服務​

2. 店鋪空間保留 確認/取消​

1. 新增訂單前需先保留空間才可成功建立訂單​

2. 重選店舖若有保留過需先取消，取得新保留編號後需再保留新編號​

3. 最終未出貨訂單需取消​

3. 建立物流訂單​

4. 物流貨態回傳​

5. 獲取出貨單號​

6. 列印全家大宗冷凍(物流標籤)​

7. 更新物流訂單​

8. 重選店鋪​

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

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

11. 查詢商家材積​

12. 取消物流單​

FamiFreezingBulkB2C物流貨態代碼​

全家大宗(冷凍)物流流程說明

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

重選店鋪:

FamiFreezingBulkB2C API

網址連結

1. 選擇物流服務

2. 店鋪空間保留確認/取消

1. 新增訂單前需先保留空間才可成功建立訂單

2. 重選店舖若有保留過需先取消，取得新保留編號後需再保留新編號

3. 最終未出貨訂單需取消

3. 建立物流訂單

4. 物流貨態回傳

5. 獲取出貨單號

6. 列印全家大宗冷凍(物流標籤)

7. 更新物流訂單

8. 重選店鋪

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

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

11. 查詢商家材積

12. 取消物流單

FamiFreezingBulkB2C物流貨態代碼