Skip to main content

711Bulk-API V2.4

7-11常溫大宗物B2C流流程說明

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

導向到選擇物流服務,取得店鋪相關資訊(店號、店名、店址、物流服務、訂單編號回傳至回傳店號網址)

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

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

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

於預訂出貨日進行出貨(物流標籤上的門市進貨日)

列印物流單

門市進貨日: 物流單上的門市進貨日為預訂出貨日(建單日期+Deadline)

若超過預定出貨日尚未出貨

未列印過標籤: 門市進貨日會改為列印日期+1天。

已列印過標籤: 請重新取號在列印標籤,門市進貨日會改為列印日期+1天。

請於此日期進行出貨並在當天到達物流總倉,不可提前到貨,提前到貨會進行刷退,逾期到貨貨在門市的日數會依晚到日數變少,如發現無法出貨可重新取號後列印標籤再依新門市進貨日出貨。

重新取號

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

配對新的出貨單號後仍要到列印7-11大宗物流列印新標籤進行大宗物流出貨。

711 大宗物流流程圖

711Bulklogisticflow


7-11Bulk API

網址連結


1. 選擇物流服務

說明

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

傳遞方式:Http POST method

API URL:/Member/Order/Choselogistics


Request

參數名稱型態長度必須備註
user_account商家主帳號string10Y
orderno訂單編號string27N
apicode商家api密碼string30Y請以TripleDESEncoding加密後傳送附錄
Logistic_serviceID物流服務IDstring2Y固定為02
returnUrl回傳店號網址string200Y

Response

參數名稱型態長度必須備註
orderno商家訂單編號string20Y如有帶入訂單編號則回傳訂單編號
service物流服務string2Y固定為02
storeaddress店址string150Y
storename店名string30Y
storeid店IDstring10Y

2. 建立物流訂單

說明

  • 建立物流訂單

傳遞方式:Http POST method

API URL:/api/Orderapi/Add_Order


Request

參數名稱型態長度必須備註
JsonOrder物流單資料stringYJson字串以TripleDESEncoding加密後urlencode傳送附錄
Json Content
參數名稱型態長度必須備註
user_account商家主帳號string10Y
apicode商家api密碼string30Y
Logistic_service物流服務代碼string2Y固定為02
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長度限制須至少包含
1.兩個中文字或4個英文字
2.最多五個中文字或10個英文字不得包含 , 號
Receiver_Phone收件人手機string10Y
Receiver_Email 收件人EMAILstring100Y
Receiver_address收件人地址string150Y
Sender_Name 寄件人姓名string10Y請填空字串,會自動帶入立吉富
Sender_Phone寄件人手機string10Y請填空字串,會自動帶入0900000000
Sender_Email寄件人EMAILstring100Y
Sender_address寄件人地址string150Y如不填入 請填空字串
PassCode傳遞碼stringYPassCode組成方法
1. user_account + OrderNo + TotalAmount + apicode
2. 使用SHA-1雜湊函數取得組合字串的雜湊值 附錄
Deadline預定出貨天數intY

預定出貨日

須為1~7之間的數字。

預定出貨日=建立物流單日+DeadLine

Ex:建立物流單日期為2021/03/14,Deadline為3,則預定出貨日為2021/3/17。

Response

參數名稱型態長度必須備註
Status狀態string1YS:成功 F:失敗
orderno商家訂單編號string27Y
LogisticNumberPayNow物流單號string20Y
Logistic_service物流服務名稱stringY7-11大宗物流
Logistic_serviceID物流服務IDstring2Y固定為02
ErrorMsg 錯誤訊息string2Y若成功則為null
ReturnMsg 回傳訊息string2Y
Logistic_serviceID物流服務IDstring2Y

如為7-11訂單欄位內各屬性都不可帶入Ibon 禁用字元。

Ibon禁用字元 (資料內容請勿使用以下特殊符號):

’單引號 " 雙引號 % 百分比 | pipe符號 & AND符號 ` 重音 ^ caret符號 @ at符號 ! 驚嘆號

. 點 # 井字號 ( 左括號 ) 右括號 * 米字號 _下底線 + 加號 -連接號 ;分號 :冒號 ,逗號


Objec Example

Request Object

{
"user_account":"28229955",
"apicode":"12345678",
"Logistic_service":"02",
"OrderNo":"211210165125",
"DeliverMode":"02",
"TotalAmount":"200",
"Remark":"",
"Description":"test",
"receiver_storeid":"126616",
"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":"4CF47FD844DF64C5D0FBF8DD134708B55ABE208B",
"Deadline":1
}

Response Object

{
"Status":"S",
"LogisticNumber":"MIJA0027B22112100002",
"LogisticService":"7-11大宗物流",
"LogisticServiceID":"02",
"ReturnMsg":"",
"orderno":"211210165125",
"ErrorMsg":null,
}

3. 獲取出貨單號

說明

  • 獲取出貨單號

傳遞方式:Http POST method

API URL:/api/Bulk711Order/ShipBulk711paymentno


Request

參數名稱型態長度必須備註
JsonOrder物流單資料stringYJson字串以TripleDESEncoding加密後urlencode傳送附錄
Json Content
參數名稱型態長度必須備註
user_account商家主帳號string10Y
apicode商家api密碼string30Y
PassCode傳遞碼stringYPassCode組成方法
1. user_account + apicode
2. 使用SHA-1雜湊函數取得組合字串的雜湊值 附錄
ShipList訂單列表string10Y子JsonString,Object Array組成
ShipList Json Content
參數名稱型態長度必須備註
LogisticNumberPaynow物流單號string20Y
sno物流單序號stringY目前固定為1

Response

參數名稱型態長度必須備註
LogisticNumberPayNow物流單號string20Y
sno物流單序號string3Y目前固定為1
paymentno 配送編號string11Y
ErrorMsg 錯誤訊息string2Y若成功則為null

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
}
]

4. 列印7-11大宗物流(物流標籤)

說明

  • 列印7-11大宗物流單

傳遞方式:Http POST method

API URL:/Member/Order/Print711bulkLabel


Request

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

Response

回傳列印物流標籤畫面


Objec Example

Request Object

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

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

說明

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

傳遞方式:Http GET method

API URL:/api/Orderapi/Get_Order_Info


Request

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

Response

參數名稱型態長度必須備註
LogisticNumberPayNow物流單號string20Y
sno物流單序號intY
Response (Object)
LogisticNumberPayNow物流單號string20Y
sno物流單序號stringY
orderno商家訂單編號string30Y
Logistic_Serviece物流服務string2Y

02:7-11大宗物流

12:7-11大宗退貨便

Status狀態string1Y0:成立中訂單 1:無效訂單
Delivery_Status物流狀態string2Y流程狀態描述

PayNowLogistic

Code

物流代碼string4YPayNow物流代碼

Detail_Status_

Description

物流代碼描述stringYPayNow物流代碼詳細資訊
paymentno物流商託運單號stringY
ErrorMsg錯誤訊息stringYNull則為查詢成功

Objec Example

Request Object

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

Response Object

{
"LogisticNumber":"MIJA0027B22112100002",
"orderno":"211210165125",
"Logistic_Serviece":"02",
"Status":"0",
"Delivery_Status":null,
"PayNowLogisticCode":"",
"Detail_Status_Description":"",
"sno":"1",
"ErrorMsg":null,
"paymentno":"",
}

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

說明

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

傳遞方式: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物流服務string2Y

02:7-11大宗物流

12:7-11大宗退貨便

Status 狀態string1Y0:成立中訂單 1:無效訂單
Delivery_Status 物流狀態string2Y流程狀態描述

PayNowLogistic

Code

物流代碼string4YPayNow物流代碼

Detail_Status_

Description 

物流代碼描述stringYPayNow物流代碼詳細資訊
paymentno物流商託運單號stringY
ErrorMsg 錯誤訊息stringYNull則為查詢成功

Objec Example

Request Object

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

Response Object

{
"LogisticNumber":"MIJA0027B22112100002",
"orderno":"211210165125",
"Logistic_Serviece":"02",
"Status":"0",
"Delivery_Status":null,
"PayNowLogisticCode":"",
"Detail_Status_Description":"",
"sno":"1",
"ErrorMsg":null,
"paymentno":"",
}

7. 重新取號

說明

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

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

    2. (貨態為1000:訂單上傳中、1050:物流訂單上傳成功、8000:買家已取件,無法重新取號)

傳遞方式: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雜湊函數取得組合字串的雜湊值 附錄2

Response

參數名稱型態長度必須備註
Status狀態string1YS:成功 F:失敗
LogisticNumberPayNow物流單號string20Y
OrderNo商家原始訂單編號string27Y
sno物流單序號intY
paynoworderno新訂單編號string30Y商家原始訂單編號
paymentno物流商貨運編號stringY重新取號後新的物流商貨運編號
ErrorMsg 錯誤訊息stringY成功則為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
}

8. 取消物流單

說明

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

傳遞方式: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,訂單取消失敗 失敗原因: 失敗原因

9. 物流貨態回傳

說明

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

10. 更新物流訂單

說明

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

傳遞方式:Http PUT method

API URL:/api/Bulk711Order/UpdateB2C711Order


Request

參數名稱型態長度必須備註
UpdateOrder物流單資料stringY請帶入UpdateBulk711Order JSON字串
UpdateBulk711Order 主物件
LogisticNumberPaynow物流單號string20Y
sno物流單序號intY
PassCode傳遞碼stringY將以下參數值依序組合起來成一段字串(不包含+號) : user_account + Orderno + TotalAmount + apicode並使用SHA-1雜湊函數取得組合字串的雜湊值 附錄
receiver_storeid取件店號string6N
receiver_storename取件店名string100N
Receiver_Name收件人姓名string10N長度限制須至少包含兩個中文字或4個英文字,最多五個中文字或10個英文字不得包含 , 號
Receiver_Phone收件人電話string10N

Response

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

11. 門市更新(關轉)

說明

  • 接收到門市關轉需求的訂單由此API指定新門市進行配送
  • 請於收到貨態代碼4036日期D+2的上午11:20前關轉,逾期則無法關轉,例如:2020/10/07收到4036的貨態代碼,請於10/09 11:20前打此API進行更換門市
  • 關轉發生原因:進行出貨後因各種狀況無法將包裹配達指定門市,需請商家/消費者更換取件門市

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

API URL: /api/Orderapi/Put


Request

參數名稱型態長度必須備註
UpdateOrder物流單資料stringY
LogisticNumberPAYNOW物流單號string20Y
sno物流單序號intY
ChangeType改變方式string2Y01:取件門市更新 02:退件門市更新
NewStoreId新門市店號stringY
NewStoreName新門市名稱stringY
PassCode傳遞碼stringY以下參數值依序組合起來成一段字串(不包含+號) : user_account + Orderno + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值 附錄

Response

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

Objec Example

Request Object

{
"LogisticNumber":"MIJA0027B22112100002",
"sno":"1",
"ChangeType":"01",
"NewStoreId":"863698",
"NewStoreName":"豫銘門市",
"PassCode":"4CF47FD844DF64C5D0FBF8DD134708B55ABE208B"
}

12. 建立退貨物流單

說明

  • 建立退貨物流單取得退貨代碼

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

API URL: /api/Orderapi/ReturnPaymentno

Request

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

JsonOrder Content

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

Response

參數名稱型態長度必須備註
Status狀態string1YS:成功 F:失敗
LogisticNumberPayNow物流單號string20Y
LogisticService物流服務名稱stringY7-11大宗退貨便
LogisticServiceID物流服務代碼string2Y02:7-11大宗物流
ErrorMsg錯誤訊息stringY成功則為null
paymentno物流商貨運編號stringY退貨便配送編號,請於IBon機台輸入並列印物流單
ReturnMsg回傳訊息stringY
orderno商家訂單編號string27Y

Objec Example

Request Object

{
"user_account":"28229955",
"apicode":"12345678",
"LogisticNumber":"MIJA0027B22112100002",
"LogisticServiceID":"02",
"PassCode":"24BCF048A550B56D74F9C342DCFA3FA01DBD2AFB
}

Response Object

{
"Status":"S",
"LogisticNumber":"MIJA0027R42112130001",
"LogisticService":"7-11大宗退貨便",
"LogisticServiceID":"12",
"ErrorMsg"null,
"paymentno":"A47058871088",
"ReturnMsg":"",
"orderno":"MIJA0027B22112100002"
}

7-11大宗物流貨態代碼

貨態代碼
貨態代碼貨態描述
7-11大宗1000訂單檔案上傳中
1050物流訂單上傳成功
1071XML 格式不正確,請聯繫系統商
1072檔案名稱已存在資料庫,請聯繫系統商
1073檔案名稱格式不符合規定,請聯繫系統商
1074無檔案上傳,請聯繫系統商
1075檔案內容毀損,請聯繫系統商
1080門市店號轉換成功
2001XML內容或標籤缺少
2002出貨單號超出分配號碼範圍
2003XML 檔內出或單號重複
2004非有效日期
2005出貨單號已存在
2006出貨單狀態錯誤
2007訂單已存在
2008門市代號不符
2009出貨日期不符
2013已過門市進貨日
2015檔案內容格式不符規定
2017資料異常
2107母廠商不存在
2108子廠商不存在
2110門市已關轉
2112服務類型不符合規定,請聯繫系統商
2118代收金超過上限
2120XML格式不符合規定
2121取貨姓名為空白
3001物流作業驗收中
3002門市已更新店號
3101無此門市將進行退貨
3102六、日門市不配送
3103門市關轉店
3104門市尚未開店
3105曾經重複出貨,無法出貨
4000進驗成功
4003商品捆包
4004商品外帶透明
4005商品多標籤
4009物流中心未收到貨
4031商品破損退貨中
4032商品超才退貨中
4033違禁品進行罰款退貨中
4034同一個訂單兩包商品資料重複
4035已過門市進貨日
4036門市關轉請更新門市
4037條碼規格錯誤
4038條碼無法判讀
4039無標籤
4060物流中心理貨中
4061商品遺失
4062門市不配送
4063包裹異常不配送
4099不正常到貨,商品提早到達物流中心
5000取件門市配達
5011作業錯誤
5012車輛故障
5013天候不佳
5014道路中斷
5015門市停業
5016缺件
5017門市報缺
5019取件貨態異常協尋中
5102管制品取件門市配達
5201EC收退
5202交貨便收件
5203退貨便收件
5204異常收退
5303取件遺失進行賠償作業
6001第一次開退
7001正常一退
7002正常二退
7011商品瑕疵
7012門市關店
7013門市轉店
7014廠商要求
7015商品為違禁品,將進行退貨處理與罰款
7021刷 A 給 B(退貨原因,倉儲回報)
7022消費者要求
8000買家已取件
8001退貨成功
8003商品捆包
8004商品外帶透明
8005商品多標籤
8011商品瑕疵
8012門市轉店
8013門市轉店
8014廠商要求
8015商品為違禁品,將進行退貨處理與罰款
8016天候路況不佳(離島海運)
8021刷 A 給 B(退貨原因,退貨成功)
8022消費者要求
8031商品破損
8032超才
8033商品為違禁品,將進行退貨處理與罰款
8034訂單資料重複
8035已過門市進貨日(未於指定時間內寄至物流中心)
8036更換門市
8037條碼規格錯誤
8038條碼無法判讀
8039條碼資料錯誤
8099不正常到貨,商品提早到達物流中心
8110賣家已取件-代收金額錯誤
9411貨態停滯
7-11退貨便 0001訂單已成立 等待退貨
0101商品已到寄件門市
7001正常一退
8001退貨成功
貨態代碼流變動程
一般出貨流程(成功取件)
1000->1050->3001->4000->5000->8000
一般出貨流程(退貨成功)
1000->1050->3001->4000->5000->6001->5201->7001->8001
門市關轉(更新門市後取件成功)
1000->1050->3101->4036->1080->5000->8000
門市關轉(未更新門市後退件)
1000->1050->3101->4036->8036