Introduction
- In order for Merchant to use B2C logistics (Family Mart or 7-ELEVEN), a label inspection must be passed before any B2C logistics orders can be created. This API can create all test order information needed for the label inspection.
- It can be printed in the background of the manufacturer management, or via (B2C with shipping label test), Home delivery.
API URLs
- Stage：https://logistics-stage.ecpay.com.tw/Express/CreateTestData
- Production：https://logistics.ecpay.com.tw/Express/CreateTestData
HTTPS Transfer Protocol
- HTTP Method：POST
- Accept：text/html
- Content Type：application/x-www-form-urlencoded
Request Parameter Description
MerchantID String(10)
Required
ClientReplyURL String(200)
Client-side reply URL
When this parameter is not empty, page will be redirected to this URL once a logistic order has been created.
PlatformID String(10)
LogisticsSubType String(20)
Required
- FAMI: Family Mart
- UNIMART: 7-ELEVEN
- UNIMARTFREEZE: refrigeration transportation of 7-ELEVEN
Special Note：the above should pass the shipping label test firstly then the shipment orders can be created.
CheckMacValue String
Required
Response Parameter Description
MerchantID String(9)
MerchantTradeNo String(20)
Merchant transaction number
RtnCode String
Current logistics status
RtnMsg String(200)
Logistics status description
AllPayLogisticsID String(20)
ECPay logistics transaction number.
LogisticsType String(20)
The logistics method selected by member.
Please refer to the logistics method list
LogisticsSubType String(20)
Logistics subtype
GoodsAmount Int
Goods price value
UpdateStatusDate String(20)
ReceiverName String(60)
Recipient’s name
ReceiverPhone String(20)
Recipient’s phone number
ReceiverCellPhone String(20)
ReceiverEmail String(50)
Recipient’s email
ReceiverAddress String(200)
Recipient’s address
BookingNote String(50)
Consignment number
- blank
CVSPaymentNo String(15)
Shipping number
- blank
CVSValidationNo String(10)
Verification code
- blank
CheckMacValue String
Special Note：
- Before using the [B2C] services, make sure to complete the shipping label test by sending the test labels to logistics center to ensure the labels can be read. The address of logistics center can be seen as follows. If the shipping label test fails, all shipment will not be accepted and processed as returns. Orders can be created only if the shipping label test is passed.
- Address of each logistics center:
- FamilyMart: “335 桃園市大溪區新光東路76巷22-2號。日翊文化電子商務部- EC測標收” (for label inspection purpose only.)
- 7-ELEVEN: “238 新北市樹林區佳園路二段70-1號。大智通文化行銷-EC驗收組收” (for label inspection purpose only.)
- For 7-ELEVEN: When the testing order is created, the testing label should be printed before 14:00 of the 5th day since the date of creation (D+5). Otherwise the shipping label test cannot be printed.
- For FamilyMart: When the testing order is created, the testing label should be printed within 6 days since creation. Otherwise the shipping label test cannot be printed.before 14:00 of the 5th day since the date of creation (D+5).
- To see the label test result on ECPay’s dashboard: see the following path (see the following sample screenshots as well.)：
- For both FamilyMart and 7-ELEVEN: ECPay’s dashboard → Logistics management: (the dashboard is in Chinese only.)。
Response Messages Sample：
- Correct：
1|MerchantID=XXX&MerchantTradeNo=XXX&RtnCode=XXX&RtnMsg=XXX&AllPayLogisticsID=XXX&LogisticsType=XXX&LogisticsSubType=XXX&GoodsAmount=XXX&UpdateStatusDate=XXX&ReceiverName=XXX&ReceiverPhone=XXX&ReceiverCellPhone=XXX&ReceiverEmail=XXX&ReceiverAddress=XXX&BookingNote=&CVSPaymentNo=XXX&CVSValidationNo=XXX &CheckMacValue=XXX
- Error：
0| ErrorMessage