Logistics API Document​

Home Delivery / Return Orders of Home Delivery

Introduction

In the event of a return, a reverse logistics order is generated and the home delivery operator will collect the goods from the return address.
❗ Special Note：Chunghwa Post does not provide reverse logistics services.

API URLs

  • Stage：https://logistics-stage.ecpay.com.tw/Express/ReturnHome
  • Production：https://logistics.ecpay.com.tw/Express/ReturnHome

HTTPS Transfer Protocol

  • Accept：text/html
  • Content Type：application/x-www-form-urlencoded
  • HTTP Method：POST

Request Parameter Description

MerchantID String(10)
Required

Provided by ECPAY

AllPayLogisticsID String(20)

logistics order number

❗Special Note：Select between logistics subtype [LogisticsSubType], may not be left empty
Numbers only, no special symbols nor letters

LogisticsSubType String(20)

Logistics subtype

  • TCAT: TCAT Home Delivery

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • This parameter cannot be null if [AllPayLogisticsID] is null.

ServerReplyURL String(200)
Required

Server-side reply URL.

  • Logistics status notifications will be sent via this URL.

SenderName String(10)

Return sender’s name.
  •  If the AllPayLogisticsID contains a value and the order is of the same “Logistics Subtype“, then the return recipient and sender’s information will be automatically filled in by reversing the original order sender and recipient. Other information such as specifications, temperature, distance, and goods name will also be filled in automatically.
  • Should any information differ from the original shipment, the fields may be modified manually.

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, this parameter cannot be null.
  • The length is limited to a maximum of 10 characters (5 words in Chinese and 10 words in English).

SenderPhone String(20)

Return person phone.

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, then either this parameter or the returning sender’s mobile phone number [SenderCellPhone] must be filled in and may not be left empty.
  • Numbers + special characters are allowed. Special character are limited to only ()-# .
  • Only a 10-digit numeric string beginning with 09 is allowed.

SenderCellPhone String(20)

Return sender’s mobile phone number.

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, then either this parameter or the return sender’s phone number [SenderPhone] must be filled in and may not be left empty.
  • Only a 10-digit numeric string beginning with 09 is allowed.

SenderZipCode String(6)

Return sender’s zip code.

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, this parameter cannot be null.

SenderAddress String(60)

Return sender’s address.

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter value must be greater than 6 but less than 60 characters.
  • If the logistics transaction number [AllPayLogisticsID] is null, then this parameter value must be greater than 6 but less than 60 characters.

ReceiverName String(10)

Recipient’s name.

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, this parameter cannot be null.
  • Limited to 10 characters. (Up to 5 Chinese characters or 10 English characters), no blank spaces. System will automatically remove all spaces.

ReceiverPhone String(20)

Recipient’s phone number.

❗Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, then either this parameter or the recipient’s mobile phone number [ReceiverCellPhone] must be filled in and may not be left empty.
  • Allow numbers + special symbols; special symbols only ()-# .

ReceiverCellPhone String(20)

Recipient phone.

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, then either this parameter or the recipient’s mobile phone number [ReceiverPhone] must be filled in and may not be left empty.
  • Only a 10-digit numeric string beginning with 09 is allowed.

ReceiverZipCode String(6)

Recipient’s postal code.

❗ Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, this parameter cannot be null.

ReceiverAddress String(60)

Recipient’s address.

❗Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter value must be greater than 6 but less than 60 characters.
  • If the logistics transaction number [AllPayLogisticsID] is null, then this parameter value must be greater than 6 but less than 60 characters.

ReceiverEmail String(50)

Recipient’s email.

❗Special Note：

  • If the logistics transaction number [AllPayLogisticsID] is not null, and the original logistics type [LogisticsType] is HOME (home delivery), this parameter may be left null; if [LogisticsType] is CVS, then this parameter may not null.
  • If the logistics transaction number [AllPayLogisticsID] is null, this parameter cannot be null.

GoodsAmount Int
Required

Goods price value.
  • Value ranges from $1 to $20,000 NTD.
  • Compensation amount for lost goods, numbers only.

GoodsName String(60)

Goods Name.
  • Characters including ^ ‘ ` ! @ # % & * + \ ” < > | _ [ ] and other special symbols are not allowed.
  • If the [LogisticsSubType] is TCAT, please do not use the fullwidth symbol.

Temperature String(4)

Temperature
  • 0001: Normal temperature (default)
  • 0002: Refrigerated
  • 0003: Freezer

Distance String(2)

Distance
  • 00: Same city/county (preset value)
  • 01: Other cities/counties
  • 02: Outlying island

❗ Special Note：When the system checks that the ReceiverAddress and the SenderAddress do not match the value entered for Distance, the system will automatically correct the Distance to the correct value.

Specification String(4)

Specifications
  • 0001: 60cm (default)
  • 0002: 90cm
  • 0003: 120cm
  • 0004: 150cm

❗ Special Note：When 0002:Refrigerated and 0003: freezer are chosen for temperature, the specification does not include the 0004:150cm option

ScheduledPickupTime String(1)

Scheduled pickup time period
  • Scheduled pick-up times for home delivery logistics providers.
  • No scheduled pick-up time slots are currently available, please bring in a fixed number of 4 (unlimited hours).

ScheduledDeliveryTime String(2)
 

Scheduled delivery times for home delivery items.

  • 1: Before 13:00
  • 2: 14:00 – 18:00
  • 3: 14:00 – 18:00
  • 4: No preference. When the sub-logistics type is home delivery, the following time

Remark String(200)

PlatformID String(10)

  • Provided by ECPAY, this parameter is for Platform use. Regular merchants please pass null.
  • When used by Platform, please use the MerchantID bound with merchant account

CheckMacValue String
Required

Checksum.

Response Parameter Description

Return plain text value

  • Success if value returns 1|OK
  • Failure if value returned is not 1|OK
				
					1|OK

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

Green World