711Bulk-API V2.4
7-11常溫大宗物B2C流流程說明
取得店鋪資料並成立訂單取號
導向到選擇物流服務,取得店鋪相關資訊(店號、店名、店址、物流服務、訂單編號回傳至回傳店號網址)
完善訂單資料後組成JSON字串Post到建立物流單
建立訂單成功後帶入指定資料打向獲取出貨單取得配送編號
取得配送編號後至列印7-11大宗物流網址獲取物流單標籤
於預訂出貨日進行出貨(物流標籤上的門市進貨日)
列印物流單
門市進貨日: 物流單上的門市進貨日為預訂出貨日(建單日期+Deadline)
若超過預定出貨日尚未出貨
未列印過標籤: 門市進貨日會改為列印日期+1天。
已列印過標籤: 請重新取號在列印標籤,門市進貨日會改為列印日期+1天。
請於此日期進行出貨並在當天到達物流總倉,不可提前到貨,提前到貨會進行刷退,逾期到貨貨在門市的日數會依晚到日數變少,如發現無法出貨可重新取號後列印標籤再依新門市進貨日出貨。
重新取號
需等物流驗收後且不能是已取貨的狀態才能重新取號。
配對新的出貨單號後仍要到列印7-11大宗物流列印新標籤進行大宗物流出貨。
711 大宗物流流程圖
7-11Bulk API
網址連結
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 | 固定為02 |
returnUrl | 回傳店號網址 | string | 200 | Y |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
orderno | 商家訂單編號 | string | 20 | Y | 如有帶入訂單編號則回傳訂單編號 |
service | 物流服務 | string | 2 | Y | 固定為02 |
storeaddress | 店址 | string | 150 | Y | |
storename | 店名 | string | 30 | Y | |
storeid | 店ID | string | 10 | Y |
2. 建立物流訂單
說明
- 建立物流訂單
傳遞方式:Http POST method
API URL:/api/Orderapi/Add_Order
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
JsonOrder | 物流單資料 | string | Y | Json字串以TripleDESEncoding加密後urlencode傳送附錄 |
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
user_account | 商家主帳號 | string | 10 | Y | |
apicode | 商家api密碼 | string | 30 | Y | |
Logistic_service | 物流服務代碼 | string | 2 | Y | 固定為02 |
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 | 長度限制須至少包含 1.兩個中文字或4個英文字 2.最多五個中文字或10個英文字不得包含 , 號 |
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 | PassCode組成方法 1. user_account + OrderNo + TotalAmount + apicode 2. 使用SHA-1雜湊函數取得組合字串的雜湊值 附錄 | |
Deadline | 預定出貨天數 | int | Y | 預定出貨日 須為1~7之間的數字。 預定出貨日=建立物流單日+DeadLine Ex:建立物流單日期為2021/03/14,Deadline為3,則預定出貨日為2021/3/17。 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
Status | 狀態 | string | 1 | Y | S:成功 F:失敗 |
orderno | 商家訂單編號 | string | 27 | Y | |
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
Logistic_service | 物流服務名稱 | string | Y | 7-11大宗物流 | |
Logistic_serviceID | 物流服務ID | string | 2 | Y | 固定為02 |
ErrorMsg | 錯誤訊息 | string | 2 | Y | 若成功則為null |
ReturnMsg | 回傳訊息 | string | 2 | Y | |
Logistic_serviceID | 物流服務ID | string | 2 | Y |
如為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 | 物流單資料 | string | Y | Json字串以TripleDESEncoding加密後urlencode傳送附錄 |
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
user_account | 商家主帳號 | string | 10 | Y | |
apicode | 商家api密碼 | string | 30 | Y | |
PassCode | 傳遞碼 | string | Y | PassCode組成方法 1. user_account + apicode 2. 使用SHA-1雜湊函數取得組合字串的雜湊值 附錄 | |
ShipList | 訂單列表 | string | 10 | Y | 子JsonString,Object Array組成 |
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumber | Paynow物流單號 | string | 20 | Y | |
sno | 物流單序號 | string | Y | 目前固定為1 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
sno | 物流單序號 | string | 3 | Y | 目前固定為1 |
paymentno | 配送編號 | string | 11 | Y | |
ErrorMsg | 錯誤訊息 | string | 2 | Y | 若成功則為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
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumbers | Paynow物流單號組成的字串 | string | Y | Paynow物流單號+底線+物流單子序號 多筆之間用 , 相隔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
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
sno | 物流單序號 | int | Y | 固定為1 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
sno | 物流單序號 | int | Y | ||
Response (Object) | |||||
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
sno | 物流單序號 | string | Y | ||
orderno | 商家訂單編號 | string | 30 | Y | |
Logistic_Serviece | 物流服務 | string | 2 | Y | 02:7-11大宗物流 12:7-11大宗退貨便 |
Status | 狀態 | string | 1 | Y | 0:成立中訂單 1:無效訂單 |
Delivery_Status | 物流狀態 | string | 2 | Y | 流程狀態描述 |
PayNowLogistic Code | 物流代碼 | 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":"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 | 商家訂單編號 | 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 | 02:7-11大宗物流 12:7-11大宗退貨便 |
Status | 狀態 | string | 1 | Y | 0:成立中訂單 1:無效訂單 |
Delivery_Status | 物流狀態 | string | 2 | Y | 流程狀態描述 |
PayNowLogistic Code | 物流代碼 | 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":"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 | 物流單資料 | 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雜湊函數取得組合字串的雜湊值 附錄2 |
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
}
8. 取消物流單
說明
- 將該張物流單更改為無效訂單,若為出貨中大宗訂單無法使用功
傳遞方式: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,訂單取消失敗 失敗原因: 失敗原因 |
9. 物流貨態回傳
說明
- 商家接收物流貨態,更新貨態時由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 商品實際到店時間 |
10. 更新物流訂單
說明
- 更改未出貨的訂單資料,請在未完成出貨程序前使用
傳遞方式:Http PUT method
API URL:/api/Bulk711Order/UpdateB2C711Order
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
UpdateOrder | 物流單資料 | string | Y | 請帶入UpdateBulk711Order JSON字串 | |
UpdateBulk711Order 主物件 | |||||
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
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
string | Y | 純字串 成功回傳: 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 | 物流單資料 | string | Y | ||
LogisticNumber | PAYNOW物流單號 | string | 20 | Y | |
sno | 物流單序號 | int | Y | ||
ChangeType | 改變方式 | string | 2 | Y | 01:取件門市更新 02:退件門市更新 |
NewStoreId | 新門市店號 | string | Y | ||
NewStoreName | 新門市名稱 | string | Y | ||
PassCode | 傳遞碼 | string | Y | 以下參數值依序組合起來成一段字串(不包含+號) : user_account + Orderno + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值 附錄 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
string | Y | 純字串 成功回傳: 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 | 物流單資料 | 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 | 02:7-11大宗物流 |
PassCode | 傳遞碼 | string | Y | 以下參數值依序組合起來成一段字串(不包含+號) : user_account + LogisticNumber + apicode並使用sha-1雜湊函數取得組合字串的雜湊值附錄 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
Status | 狀態 | string | 1 | Y | S:成功 F:失敗 |
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
LogisticService | 物流服務名稱 | string | Y | 7-11大宗退貨便 | |
LogisticServiceID | 物流服務代碼 | string | 2 | Y | 02:7-11大宗物流 |
ErrorMsg | 錯誤訊息 | string | Y | 成功則為null | |
paymentno | 物流商貨運編號 | string | Y | 退貨便配送編號,請於IBon機台輸入並列印物流單 | |
ReturnMsg | 回傳訊息 | string | Y | ||
orderno | 商家訂單編號 | string | 27 | Y |
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大宗物流貨態代碼
貨態代碼流變動程 |
---|
一般出貨流程(成功取件) |
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 |