Skip to main content

FamilyFreezingC2C V2.2

全家店到店(冷凍)物流流程說明

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

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

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

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

建立訂單成功後至列印全家店到店冷凍物流網址獲取物流單標籤

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

(寄貨外箱須於全家購買,可在寄件前下載My FamiPort APP至附近全家預購寄件專用紙箱)

FamiFreezingC2C流程圖

famifreezingC2Cflow


FamiFreezingC2C API

網址連結


1. 選擇物流服務

說明

  • 使用者在此頁面選擇取貨門市,選擇完畢後回傳門市資訊至帶入的回傳網址
  • 當同一筆訂單編號進行重新選店,將清除原有的店鋪資料與取消保留編號

傳遞方式:Http POST method

API URL:/Member/Order/Choselogistics


Request

參數名稱型態長度必須備註
user_account商家主帳號string10Y
orderno訂單編號string27N
apicode商家api密碼string30Y請以TripleDESEncoding加密後傳送附錄
Logistic_serviceID物流服務IDstring2Y23:全家店到店物流(冷凍)
returnUrl回傳網址string200Y回傳店號網址
EcplateformEC平台string20N

Response

參數名稱型態長度必須備註
orderno商家訂單編號string20Y如有帶入訂單編號則回傳訂單編號
service物流服務string2Y23:全家店到店物流(冷凍)
storeaddress店址string150Y
storename店名string30Y
storeid店IDstring10Y
ReservedNo保留編號string20Y超商預定冷凍存放空間編號
ShipDate出貨日期string10Y格式:yyyy-MM-dd
請於此日期前建立訂單並出貨

2. 建立物流訂單

說明

  • 建立物流訂單

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

API URL:/api/Orderapi/Add_Order

Request

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

JsonOrder Content

參數名稱型態長度必須備註
user_account商家主帳號string10Y
apicode商家api密碼string30Y
Logistic_service使用的物流服務string2Y固定為23 全家冷凍店到店
OrderNo商家訂單編號string27Y限英文與數字
DeliverMode取貨是否付款string2Y01:取貨付款 02:取貨不付款
TotalAmount總金額string5Y正整數且金額不可大於20000
Remark備註string200Y若不填入值請填空字串
Description單號描述string50Y若不填入值請填空字串
ECEC平台string50N
receiver_storeid取件店號string30Y
receiver_storename取件店名string100Y
return_storeid退件店號string6Y若不填入值請填空字串
Receiver_Name收件人姓名string10Y中文最多10個字、英文20個字
Receiver_Phone收件人手機string10Y
Receiver_Email收件人EMAILstring100Y
Receiver_address收件人地址string150Y請輸入取件店址
Sender_Name寄件人姓名string10Y中文最多10個字、英文20個字
Sender_Phone寄件人手機string10Y
Sender_Email寄件人EMAILstring100Y
Sender_address寄件人地址string150Y如不填入 請填空字串
PassCode傳遞碼stringY以下參數值依序組合起來成一段字串(不包含+號) : user_account + OrderNo + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值附錄
ReservedNo保留編號string20Y電子地圖回傳保留編號

Response

參數名稱型態長度必須備註
Status狀態string1YS:成功 F:失敗
LogisticNumberPayNow物流單號string20Y
LogisticService物流服務名稱stringY全家店到店冷凍
LogisticServiceID物流服務代碼string2Y23:全家店到店物流(冷凍)
ErrorMsg錯誤訊息stringY成功則為null
paymentno物流商貨運編號stringY超商物流配送編號
ReturnMsg回傳訊息stringY
orderno商家訂單編號string27Y

Objec Example

Request Object

{
"user_account":"28229955",
"apicode":"12345678",
"Logistic_service":"23",
"OrderNo":"211215145423",
"DeliverMode":"02",
"TotalAmount":"200",
"Remark":"",
"Description":"test",
"receiver_storeid":"005757",
"receiver_storename":"全家三重田心店",
"return_storeid":"",
"Receiver_Name":"收件測",
"Receiver_Phone":"0912345678",
"Receiver_Email":"123@paynow.com.tw",
"Receiver_address":"新北市三重區忠孝路三段50巷82號一樓",
"Sender_Name":"寄件測",
"Sender_Phone":"0900000000",
"Sender_Email":"test@paynow.com.tw",
"Sender_address":"",
"PassCode":"E73247AE62604CD2EF7EFC08480C4E7F41852C8C",
"ReservedNo":"21120300000000518064"
}

Response Object

{
"Status":"S",
"LogisticNumber":"MIJA002FR22112156425",
"LogisticService":"全家店到店冷凍",
"LogisticServiceID":"23",
"ReturnMsg":"",
"orderno":"211215145423",
"paymentno":"11000094930",
"ErrorMsg":null
}

3. 物流貨態回傳

說明

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

傳遞方式:Http Post method


Request

參數名稱型態長度必須備註
orderno商家自訂編號string30Y
OriginOrderno商家原始自訂單號string27Y
PayNowLogisticCode物流代碼string4Y
Detail_Status_Description物流狀態描述string2Y
paymentno物流商託運單號stringY
StoreDate到店日期stringN若代碼為5000/5001 商品實際到店日期
StoreTime到店時間stringN若代碼為5000/5001 商品實際到店時間

4. 列印全家店到店冷凍(物流標籤)

說明

  • 列印全家店到店冷凍物流單,列印期限訂單成立D+7

傳遞方式:Http POST method

API URL:/Member/Order/PrintFamiFreezingC2CLabel


Request

參數名稱型態長度必須備註
LogisticNumbersPaynow物流單號組成的字串stringYPaynow物流單號 +,+ 物流單子序號多筆之間用 , 區隔 EX:ABCD0017B21903001221, ABCD0017B21903001270

Response

回傳列印物流標籤畫面

5. 重新取號

說明

  • 依商家原有訂單資料進行重新取號(PayNow 物流單號、配送編號)
  • 重新取號規則

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

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

API:URL/api/Orderapi/ReNewOrder


Request

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

Json Content

參數名稱型態長度必須備註
user_account商家主帳號string10Y
LogisticNumberPaynow物流單號string20Y
sno物流單序號intY
OrderNo商家訂單編號string27Y商家原始訂單編號
TotalAmount訂單總金額string5Y
apicode商家api密碼string30Y
PassCode傳遞碼stringY以下參數值依序組合成一段字串(不包含+號)user_account + OrderNo + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值 附錄
ReservedNo保留編號string20Y電子地圖回傳保留編號

Response

參數名稱型態長度必須備註
Status狀態string1YS:成功 F:失敗
LogisticNumberPayNow物流單號string20Y
OrderNo商家原始訂單編號string27Y
sno物流單序號intY
paynoworderno新訂單編號string30Y商家原始訂單編號
paymentno物流商貨運編號stringY重新取號後新的商家訂單編號,請以此訂單編號作為批次列印與查詢的訂單編號
ErrorMsg 錯誤訊息stringY成功則為null

Objec Example

Request Object

{
"LogisticNumber":"MIJA002FR22112156425",
"OrderNo": "211215145423",
"apicode": "12345678",
"TotalAmount": "200",
"user_account": "28229955",
"PassCode": "E73247AE62604CD2EF7EFC08480C4E7F41852C8C",
"sno": "1",
"ReservedNo": "21120300000000518072"
}

Response Object

{
"LogisticNumber":"MIJA002FR22112159716", "OrderNo":"211215145423",
"paynoworderno":"211215145423_R1",
"sno":"1",
"paymentno":"11000094962",
"Status":"S",
"ErrorMsg":null
}

6. 全家店號轉換

說明

  • 轉換全家現行店號/原始店號

傳遞方式:Http GET method application/x-www-form-urlencoded

API:/api/FamiFreezingC2C/GetFamiFreezingStoreID


Request

參數名稱型態長度必須備註
storeId店號string6Y
IDtype轉換類型string1Y1:轉換成現行店號 2:轉換成原始店號

Response

參數名稱型態長度必須備註
storeId狀態string6Y
IDtype轉換類型string1Y
Error錯誤訊息stringY沒有錯誤則為空值

Response Object

{
"storeId": "017206",
"IDtype": "1",
"Error": ""
}

7. 取消物流單

說明

  • 將該張物流單更改為無效訂單
  • 取消後保留編號將無法使用、已出貨無法取消

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

API URL:/api/Orderapi/CancelOrder


Request

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

Response

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

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

說明

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

傳遞方式:Http GET method

API URL:/api/Orderapi/Get_Order_Info

Request

參數名稱型態長度必須備註
LogisticNumberPayNow物流單號string20Y
sno物流單序號intY固定為1

Response

參數名稱型態長度必須備註
LogisticNumberPayNow物流單號string20Y
sno物流單序號stringY
orderno商家訂單編號string30Y
Logistic_Serviece物流服務string2Y23:全家店到店物流(冷凍)
Status狀態string1Y0:成立中訂單 1:無效訂單
Delivery_Status物流狀態string2Y流程狀態描述
PayNowLogisticCode物流代碼string4YPayNow物流代碼
Detail_Status_Description物流代碼描述stringYPayNow物流代碼詳細資訊
paymentno物流商託運單號stringY
ErrorMsg錯誤訊息stringYNull則為查詢成功

Objec Example

Request Object

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

Response Object

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

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

說明

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

傳遞方式:Http GET method

API URL:/api/Orderapi/Get_Order_Info_orderno


Request

參數名稱型態長度必須備註
orderno商家訂單編號string30Y
user_account商家主帳號string10Y
sno物流單序號intY固定為1

Response

參數名稱型態長度必須備註
LogisticNumber PayNow物流單號string20Y
sno物流單序號stringY
orderno商家訂單編號string30Y
Logistic_Serviece物流服務string2Y23:全家店到店物流(冷凍)
Status 狀態string1Y0:成立中訂單 1:無效訂單
Delivery_Status 物流狀態string2Y流程狀態描述
PayNowLogisticCode物流代碼string4YPayNow物流代碼
Detail_Status_Description物流代碼描述stringYPayNow物流代碼詳細資訊
paymentno物流商託運單號stringY
ErrorMsg 錯誤訊息stringYNull則為查詢成功

Objec Example

Request Object

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

Response Object

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

FamiFreezingC2C物流貨態代碼

貨態代碼
貨態代碼貨態描述
0000訂單已成立 等待出貨
0101商品已到寄件門市
0102門市已更新寄件中
0103門市已更新退件中
4000進驗成功
4005商品多標籤
4007商品捆包已退
4031商品破損退貨中
4032商品超才退貨中
4039無標籤
4040條碼資料錯誤
4041貨件破損已退
4042包裝凹折已退
4043冷凍件已退
4044到貨後訂單刪除
4045貨件曾重複出貨
4046禁運品已退
4061商品遺失
4063包裹異常不配送
4067小物流遺失
4068門市遺失
4069包裝廠不良 包裝廠不良 (滲漏 )
4070門市反應商品包裝不良(滲漏)
4071門市關店
4072條碼資料重複
40737日內未寄件單號失效
4074貨物進店後發生異常提早退貨
4533商品超重
4633超重需退貨
4703貨件銷毀
4803商品捆包待廠商回覆
4805商品多標籤待廠商回覆
4832超材需退貨
4839無標籤待廠商回覆
4840條碼資料錯誤待廠商回覆
4841貨件破損待廠商回覆
4842包裝凹折待廠商回覆
4843誤進冷凍件需退貨
4844到貨時訂單刪除待廠商回覆
4845貨件曾重複出貨待廠商回覆
4846禁運品需退貨
4863包裹異常不配送待廠商回覆
4869貨件濕損待廠商回覆
4871門市關店待廠商回覆
4872條碼資料重複待廠商回覆
4941貨件破損進入賠償程序
4963異常已個案賠償
5000取件門市配達
5001退件門市配達
5200商品運送中
6004商品退回物流中心
7101取件門市關轉店
7201退件門市關轉店
8000買家已取件
8002退至全家總倉
8010買家已取件-代收金額錯誤
8020買家已取件商品有誤
8100賣家已取件
8110賣家已取件-代收金額錯誤
8120賣家已取件商品有誤
9411貨態停滯
貨態代碼流變動程
一般出貨流程(成功取件)
0101->5200->5000->8000
一般出貨流程(退貨成功)
0101->5200->5000->6004->5001->8100