Introduction
API URLs
- Stage：https://logistics-stage.ecpay.com.tw/Express/map
- Production：https://logistics.ecpay.com.tw/Express/map
HTTPS Transfer Protocol
- HTTP Method：POST
- Accept：text/html
- Content Type：application/x-www-form-urlencoded
Request Parameter Description
MerchantID String(10)
Required
Provided by ECPAY
MerchantTradeNo String(20)
- 1. Merchant transaction numbers are unique and cannot be reused.
- 2. Alphanumeric string.
LogisticsType String(20)
Required
- CVS: Convenience store pickup
LogisticsSubType String(20)
Required
Logistics subtype
When logistics type is CVS, the following types may be chosen as the logistics subtype:
B2C
Possibe values:
- FAMI: Family Mart
- UNIMART: 7-ELEVEN
- UNIMARTFREEZE: refrigeration transportation of 7-ELEVEN
- HILIFE: Hi-Life
C2C
Possible values:
- FAMIC2C: Family Mart store to store
- UNIMARTC2C: 7-ELEVEN store to store
- HILIFEC2C: Hi-Life store to store
- OKMARTC2C:OK store to store
Special Note：
- If the logistics type that the merchant apply for is B2C, this parameter can only be populated with FAMI, UNIMART, UNIMARTFREEZE or HILIFE; if it is C2C, only FAMIC2C, UNIMARTC2C, HILIFEC2C, OKMARTC2C can be populated.
IsCollection String(1)
Required
- N: Do not collect payment.
- Y: Collection payment for goods.
ServerReplyURL String(200)
Required
ExtraData String(20)
Additional information
This field allows merchants to send additional data, and Green World will respond the original value sent by merchants.
Device Int
Use equipment
Display the corresponding E-map based on Device type
- 0: PC (default)
- 1: Mobile
Special Note：
- 1.7-ELEVEN: if merchants select 7-ELEVEN, if no value is assigned to this parameter, the device will be determined by ECPay’s system; if a value is assigned, the device will be determined by the value assigned.
- 2.Family Mart: Family Mart’s E-map system has integrated PC and Mobile, so this parameter will not affect displaying result on client side. If merchants select Family Mart, please use default value (Device=0).
Response Parameter Description
MerchantID String(10)
MerchantTradeNo String(20)
Merchant transaction number
LogisticsSubType String(20)
CVSStoreID String(9)
Customer selected convenience store branch number
CVSStoreName String(10)
Customer selected convenience store branch name
CVSAddress String(60)
Customer selected convenience store branch address
CVSTelephone String(20)
Customer selected convenience store branch telephone number
Special Note：
The following logistics subtypes will not return this parameter:
- UNIMART: 7-ELEVEN
- UNIMARTC2C: 7-ELEVEN store to store
CVSOutSide String(1)
- 0: on shore of Taiwan
- 1: off shore of Taiwan
Special Note：
The following logistics subtypes will not return this parameter:
UNIMART: 7-ELEVEN
UNIMARTC2C: 7-ELEVEN store to store
ExtraData String(20)
Additional information
- Return of original data
Special Note：
- When operating on a mobile device, make sure that HTTP Cookie is allowed to run, otherwise operation errors may occur.
- If merchants receive the response message: [Encryption key not found, please check whether this logistic method is available] (as below), please check that the MerchantID is correctly paired with the [LogisticsSubType].
- If consumer is using iOS environment, merchants should remove form attribute of html code (target=”_blank”) to avoid a blank page. For more details please check FAQ.
- Please do not use in-app iframe to call e-map API, otherwise the API call will fail.
- After selecting pickup point/convenience store, the result of payload will be returned in HTML format.
- The pickup store at Stage (stage environment, testing mode) is a dummy store for API testing only, so no real pickup store of e-map will be popped up for consumers to select.
- This API only provides the function of selection pickup store only. To complete the whole process of creating shipment orders, please do not forget to integrate the API of logistics order creation (see the following chapter.)