PHPackages thoth-pharaoh/ecpay-express - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. thoth-pharaoh/ecpay-express ActiveLibrary[API Development](/categories/api) thoth-pharaoh/ecpay-express =========================== 綠界物流服務 v2.0.1(2y ago)044MITPHPPHP ^8.0 Since Oct 25Pushed 2y ago1 watchersCompare [ Source](https://github.com/castion2293/ecpay-express)[ Packagist](https://packagist.org/packages/thoth-pharaoh/ecpay-express)[ RSS](/packages/thoth-pharaoh-ecpay-express/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (2)Versions (21)Used By (0) 綠界物流服務 ====== [](#綠界物流服務) 版本匹配 ---- [](#版本匹配) Laravelpackage8.X1.X9.X2.X安裝 -- [](#安裝) 使用 composer 做安裝 ``` composer require thoth-pharaoh/ecpay-express ``` 匯出 Config --------- [](#匯出-config) ``` php artisan vendor:publish --tag=express-config --force ``` 添加 .env 支付工具必要環境參數 ------------------ [](#添加-env-支付工具必要環境參數) ``` EXPRESS_URL="https://logistics-stage.ecpay.com.tw/Express/v2/" EXPRESS_MERCHANT_ID="2000132" EXPRESS_HASH_KEY="5294y06JbISpM5x9" EXPRESS_HASH_IV="v77hoKGq4kWxNNIS" EXPRESS_VISION="1.0.0" ``` 使用方法 ---- [](#使用方法) ### 先引入門面 [](#先引入門面) ``` use Pharaoh\Express\Facades\Express; ``` ### 註冊物流相關路由 [](#註冊物流相關路由) ``` class RouteServiceProvider extends ServiceProvider { /** * Define your route model bindings, pattern filters, etc. * * @return void */ public function boot() { // 註冊物流相關路由 Express::routes(); } } ``` - [一段標測試資料產生(B2C)](#create-test-data) - [獲取開啟物流選擇頁連結](#create-logistics) - [更新暫存物流訂單](#update-temp-trade) - [建立正式物流訂單](#create-by-temp-trade) - [建立列印託運單連結](#create-trade-document) - [(B2C) 7-ELEVEN 逆物流訂單](#return-unimart-cvs) - [(B2C) 全家逆物流訂單](return-fami-cvs) - [宅配逆物流訂單](return-home) - [特店進行物流訂單查詢作業](query-logistics-trade-info) - [(B2C) 7-ELEVEN-更新出貨日、門市](update-shipment-info) - [(C2C)7-ELEVEN、全家、OK - 更新門市](update-store-info) - [取消訂單(7-EVEVEN 超商 C2C)](cancel-c2c-order) ### 一段標測試資料產生(B2C) [](#一段標測試資料產生b2c) ``` $express = Express::createTestData($type); ``` #### $type 內容說明 [](#type-內容說明) 參數名稱類型說明LogisticsSubType物流子類型String (20)支援以下超商: FAMI:全家物流(B2C) UNIMART:7-ELEVEN 超商物流(B2C)### 獲取開啟物流選擇頁連結 [](#獲取開啟物流選擇頁連結) ``` $express = Express::createLogistics($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式) 參數必填名稱類型說明GoodsAmount✔商品金額int商品金額範圍為 1~20,000 元。訂單的商品金額如果超出範圍，會訂 單失敗且回傳錯誤代碼 10500040 商品金額錯誤GoodsName✔商品名稱string(50)注意事項: 不得輸入^ ' ` ! @ # % & \* + \\ " < >SenderName✔寄件人姓名string(10)注意事項: 1.字元限制為 10 個字元(最多 5 個中文字、10 個英文字)、不可有^ ' ` ! @# % & \* + \\ " < >SenderZipCode✔寄件人郵遞區號String (5)SenderAddress✔寄件人地址String (60)IsCollection是否代收貨款String (1)N:不代收貨款，為預設值 Y:代收貨款，帶入 Y 則物流選擇頁將不會出現宅配選項Remark備註String (60)Temperature溫層String (4)宅配專用參數 0001:常溫 (預設值) 0002:冷藏 0003:冷凍 注意事項: 如物流子類型為 ECAN(宅配通)只能使用 0001 常溫Specification規格String (4)宅配專用參數 0001: 60cm (預設值) 0002: 90cm 0003: 120cm 0004: 150cm 注意事項: 溫層選擇 0002:冷藏和 0003:冷凍時， 此規格參數不可帶入 0004:150cmScheduledPickupTime預定取件時段String (1)宅配專用參數 宅配物流商預定取貨的時段 1: 912 2: 1217 4: 不限時(固定填 4 不限時) 注意事項: 當物流子類型選擇 ECAN(宅配通)時，該參數可不填PackageCount包裹件數String (20)宅配專用參數，預設值為 1 當物流子類型選擇 ECAN(宅配通)時時，此參數才有作用，表示同訂 單編號之包裹件數ReceiverAddress收件人地址String (60)若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中ReceiverCellPhone收件人手機String (20)若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中 注意事項: 只允許數字、10 碼且 09 開頭ReceiverPhone收件人電話String (20)若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中ReceiverName收件人姓名String (10)若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中EnableSelectDeliveryTime是否允許選擇送達時間String (1)N:不允許(預設值) Y:允許EshopMemberID廠商平台的會員 IDString (24)1. 允許英文、數字組成 2. 若此參數有帶入值，且使用者於物流選擇頁有勾選「您同意綠界 科技股份有限公司記錄您上述收件資訊，以利您日後於該店消費時 之收件資訊。」欄位，綠界將記錄使用者於物流選擇頁中輸入的配送通路及收件人資料，以利於下次使用物流選擇頁時，自動帶入前一次輸入的資料### 更新暫存物流訂單 [](#更新暫存物流訂單) ``` $express = Express::updateTempTrade($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式-1) 參數必填名稱類型說明TempLogisticsID✔暫存物流訂單編號string(20)GoodsAmount商品金額int商品金額範圍為 1~20,000 元。訂單的商品金額如果超出範圍，會訂 單失敗且回傳錯誤代碼 10500040 商品金額錯誤GoodsName商品名稱string(50)注意事項: 不得輸入^ ' ` ! @ # % & \* + \\ " < >SenderName寄件人姓名string(10)注意事項: 1.字元限制為 10 個字元(最多 5 個中文字、10 個英文字)、不可有^ ' ` ! @# % & \* + \\ " < >SenderZipCode寄件人郵遞區號String (5)SenderAddress寄件人地址String (60)Remark備註String (60)ReturnStoreID退貨門市代 號String (6)若沒有設定 ReturnStoreID，當貨品退貨時，會返回原寄件門市，若有設定則會送至指定的退貨門市 注意事項: 僅 7-11 C2C 適用，其他超商 C2C 帶此參數仍會退回原寄件門市Specification規格String (4)宅配專用參數 0001: 60cm (預設值) 0002: 90cm 0003: 120cm 0004: 150cm 注意事項: 溫層選擇 0002:冷藏和 0003:冷凍時， 此規格參數不可帶入 0004:150cmPackageCount包裹件數String (20)宅配專用參數，預設值為 1 當物流子類型選擇 ECAN(宅配通)時時，此參數才有作用，表示同訂 單編號之包裹件數ReceiverAddress收件人地址String (60)若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中ReceiverZipCode收件人郵遞區號String (5)ReceiverCellPhone收件人手機String (20)若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中 注意事項: 只允許數字、10 碼且 09 開頭ReceiverPhone收件人電話String (20)若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中ReceiverName收件人姓名String (10)若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中### 建立正式物流訂單 [](#建立正式物流訂單) ``` $express = Express::createByTempTrade($tempLogisticsId); ``` #### $tempLogisticsId 內容說明 [](#templogisticsid-內容說明) 參數名稱類型說明LogisticsID綠界訂單編號String (20)請保存廠商交易編號與 LogisticsID 的關連### 建立列印託運單連結 [](#建立列印託運單連結) ``` $express = Express::createTradeDocument($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式-2) 參數必填名稱類型說明LogisticsID✔綠界訂單編號Array1. 可支援單筆或批次列印 2. 流子類型\[LogisticsSubType\]與綠界訂單編號\[LogisticsID\]須為同 一物流方式 請帶入建立正式物流訂單時綠界回復之綠界訂單編號 \[LogisticsID\]LogisticsSubType✔物流子類型string(20)### (B2C) 7-ELEVEN 逆物流訂單 [](#b2c-7-eleven-逆物流訂單) ``` $express = Express::returnUniMartCVS($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式-3) 參數必填名稱類型說明GoodsAmount✔商品金額int金額範圍為 1~20,000 元 此為商品遺失賠償依據，僅可使用數字SenderName✔退貨人姓名string(50注意事項: 不可有符號不可有符號^ ' ` !@# % & \* + \\ " < >LogiscisID綠界訂單編號String (20)GoodsName商品名稱String (50)注意事項: 不得輸入^ ' ` ! @ # % & \* + \\ " < >SenderPhone退貨人手機String (20)Remark備註String (40)### (B2C) 全家逆物流訂單 [](#b2c-全家逆物流訂單) ``` $express = Express::returnFamiCVS($data); ``` #### $data 內容說明(array格式)與 7-ELEVEN 逆物流訂單 相同 [](#data-內容說明array格式與-7-eleven-逆物流訂單-相同) ### 宅配逆物流訂單 [](#宅配逆物流訂單) ``` $express = Express::returnHome($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式-4) 參數必填名稱類型說明GoodsAmount✔商品金額int金額範圍為 1~20,000 元 此為商品遺失賠償依據，僅可使用數字LogiscisID綠界訂單編號string(20)LogisticsSubType物流子類型string(20)TCAT:黑貓 ECAN:宅配通 注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值，且原物流類型\[LogisticsType\]為HOME(宅配)，本欄位可為空值 若綠界訂單編號\[LogisticsID\]有值，且原物流類型\[LogisticsType\]為CVS(超商取貨)，本欄位不可為空 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位不可為空值SenderName退貨人姓名string(10)1. 若綠界訂單編號\[LogisticsID\]有值且與該訂單為相同的「物流子類型」時，退貨收件人與寄件人資訊會與原訂單相反且自動帶入宅配規格、溫層、距離、品名 2. 若資訊與關連物流交易不同時，可自行輸入 注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值，且原物流類型\[LogisticsType\]為HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]有值，且原物流類型\[LogisticsType\]為CVS(超商取貨)，本欄位不可為空值 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位不可為空值 4. 長度限制最多 10 個字元(中文 5 個字，英文 10 個字)SenderPhone退貨人電話string(20)注意事項: 1. 若綠界訂單編號\[LogisticsID\]不為空值時，且原物流類型 \[LogisticsType\]為HOME(宅配)，本欄位可為空值 2. 若物流交易編號\[LogisticsID\]不為 空值時，且原物流類型 \[LogisticsType\] 為CVS(超商取貨)，本欄位不可為空值 3. 若物流交易編號\[LogisticsID\]為空值時，本欄位與退貨人手機 \[SenderCellPhone\]擇一不可為空) 4. 允許數字+特殊符號;特殊符號僅限 ()-#SenderCellPhone退貨人手機string(20)注意事項: 1. 若綠界訂單編號\[LogisticsID\]不為空值時，且原物流類型\[LogisticsType\] 為 HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為CVS(超商取貨)，本欄位不可為空值 3. 若綠界訂單編號\[LogisticsID\]有值時，本欄位與退貨人電話 \[SenderPhone\]擇一不可為空 4. 只允許數字、10 碼、09 開頭SenderZipCode退貨人郵遞 區號string(5)注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為CVS(超商取貨)，本欄位不可為空值 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位不可為空值SenderAddress退貨人地址string(60)注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號 \[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為 CVS(超商取貨)，本欄位字元限制需大於 6 個字元，且不可超過 60 個字元 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位字元限制需大於 6 個字元，且不可超過 60 個字元ReceiverName收件人姓名string(10)注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為CVS(超商取貨)，本欄位不可為空值 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位不可為空值 4. 字元限制為 10 個字元(最多 5 個中文字、10 個英文字)、不可有空白，若帶有空白系統自動去除ReceiverPhone收件人電話string(20)注意事項: 1. 若綠界訂單編號\[LogisticsID\]不為空值時，且原物流類型 \[LogisticsType\] 為 HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]不為空值時，且原物流類型 \[LogisticsType\] 為CVS(超商取貨)，本欄位不可為空值 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位與收件人手機 \[ReceiverCellPhone\]擇一不可為空) 4. 允許數字+特殊符號;特殊符號僅限()-#ReceiverCellPhone收件人手機string(20)注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為宅配HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為CVS(超商取貨)，本欄位不可為空值 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位與收件人電話 \[ReceiverPhone\]擇一不可為空 4. 只允許數字、10 碼、09 開頭ReceiverZipCode收件人郵遞區號string(5)注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為 HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為 CVS(超商取貨)，本欄位不可為空值 3. 若綠界訂單編號\[LogisticsID\]為空 值時，本欄位不可為空值ReceiverAddress收件人地址string(60)注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為 HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為 CVS(超商取貨)，本欄位字元限制需大 於 6 個字元，且不可超過 60 個字元 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位字元限制需大於 6 個字 元，且不可超過 60 個字元ReceiverEmail收件人 mailstring(50)注意事項: 1. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為 HOME(宅配)，本欄位可為空值 2. 若綠界訂單編號\[LogisticsID\]有值時，且原物流類型\[LogisticsType\] 為 CVS(超商取貨)，本欄位不可為空值 3. 若綠界訂單編號\[LogisticsID\]為空值時，本欄位不可為空值GoodsName物品名稱string(60)注意事項: 不得輸入^ ' ` ! @ # % & \* + \\ " < >Temperature溫層string(4)0001:常溫 (預設值) 0002:冷藏 0003:冷凍Distance距離string(2)00:同縣市 (預設值) 01:外縣市 2:離島 ※注意事項 當系統檢查到收件人地址 (ReceiverAddress)與寄件人地址 (SenderAddress)所屬縣市與距離(Distance) 輸入的值不相符時，系統將自動更正距離 (Distance)為正確值Specification規格string(4)0001: 60cm (預設值) 0002: 90cm 0003: 120cm 0004: 150cm 注意事項: 溫層選擇 0002:冷藏和 0003:冷凍時，此規格參數不可帶入 0004:150cmScheduledDeliveryTime預定送達時段string(2)1:13 前 2: 1418 4:不限時 當子物流選擇 ECAN(宅配通)時，可選擇以下時段 12:13 前 23: 1418 4:不限時ScheduledDeliveryDate指定送達日string(10)當物流子類型選擇 ECAN(宅配通)時，此參數才有作用 注意事項: 日期指定限制 D+3 (D:該訂單建立時間)Remark備註string(60)PlatformID特約合作平台商代號string(10)由綠界科技提供，此參數為專案合作的平 台商使用，一般廠商介接 請放空值。若為專案合作的平台商使用時，MerchantID 請帶賣家所綁定的 MerchantID### 特店進行物流訂單查詢作業 [](#特店進行物流訂單查詢作業) ``` $express = Express::queryLogisticsTradeInfo($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式-5) 參數必填名稱類型說明LogiscisID綠界訂單編號string(20)與 MerchantTradeNo(廠商交易編號)需二擇一填寫MerchantTradeNo廠商交易編號string(20)1. 廠商交易編號均為唯一值，不可重複使用 2. 英數字大小寫混合 3. 與 LogisticsID(綠界訂單編號)需二擇一填寫### (B2C) 7-ELEVEN-更新出貨日、門市 [](#b2c-7-eleven-更新出貨日門市) ``` $express = Express::updateShipmentInfo($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式-6) 參數必填名稱類型說明LogiscisID✔綠界訂單編號string(20)ShipmentDate物流訂單出貨日 期string(10)物流訂單出貨日期(貨到物流中心的日期)、物流訂單取貨門市需擇一必填ReceiverStoreID物流訂單取貨門市string(6)物流訂單出貨日期(貨到物流中心的日期)、物流訂單取貨門市需擇一必填 注意事項: 1. 當 7-ELEVEN 貨態為 2037 門市關轉時，才能變更取貨門市 2. 收到 2037 門市關轉貨態時，請於第 3 日早上 10 點前(如5/26 當天收到門市關轉貨態，須於 5/28 早上 10 點前回傳) 變更取貨門市### (C2C)7-ELEVEN、全家、OK - 更新門市 [](#c2c7-eleven全家ok---更新門市) ``` $express = Express::updateStoreInfo($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式-7) 參數必填名稱類型說明LogiscisID✔綠界訂單編號string(20)CVSPaymentNo✔寄貨編號string(15)CVSValidationNo✔驗證碼string(10)若為 OK 超商非必填StoreType✔門市類型string(2)01:取件門市更新 02:退件門市更新ReceiverStoreID物流訂單取貨門市string(6)注意事項: 物流訂單取貨門市、物流訂單退貨門市 需擇一必填ReturnStoreID物流訂單退貨門市string(6)注意事項: 物流訂單取貨門市、物流訂單退貨門市 需擇一必填### 取消訂單(7-EVEVEN 超商 C2C) [](#取消訂單7-eveven-超商-c2c) ``` $express = Express::cancelC2COrder($data); ``` #### $data 內容說明(array格式) [](#data-內容說明array格式-8) 參數必填名稱類型說明LogiscisID✔綠界訂單編號string(20)CVSPaymentNo✔寄貨編號string(15)CVSValidationNo✔驗證碼string(10)### 物流狀態通知事件 [](#物流狀態通知事件) ``` use Pharaoh\Express\Events\ServerReplyEvent; class EventServiceProvider extends ServiceProvider { ServerReplyEvent::class => [ ServerReplyListener::class ] } ``` 物流狀態通知處理任務請在專案中的 ServerReplyListener 實作 type 有兩種 temp\_trade\_reply(貨態通知) 及 return\_trade\_reply(逆物流通知) ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community7 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~37 days Recently: every ~175 days Total 20 Last Release 950d ago Major Versions v0.0.18 → v1.0.02021-11-03 v1.0.0 → v2.0.02022-02-16 PHP version history (2 changes)v0.0.2PHP ^7.3|^8.0 v2.0.0PHP ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/f2c93261d26309cd6e0f93f11c0703d9e2c7e6d9ad068d19a7111fdb85d181f9?d=identicon)[castion2293](/maintainers/castion2293) --- Top Contributors [![castion2293](https://avatars.githubusercontent.com/u/20082281?v=4)](https://github.com/castion2293 "castion2293 (40 commits)") ### Embed Badge ![Health badge](/badges/thoth-pharaoh-ecpay-express/health.svg) ``` [![Health](https://phpackages.com/badges/thoth-pharaoh-ecpay-express/health.svg)](https://phpackages.com/packages/thoth-pharaoh-ecpay-express) ``` ### Alternatives [mollie/laravel-mollie Mollie API client wrapper for Laravel & Mollie Connect provider for Laravel Socialite 3624.1M28](/packages/mollie-laravel-mollie)[mll-lab/laravel-graphiql Easily integrate GraphiQL into your Laravel project 683.2M9](/packages/mll-lab-laravel-graphiql)[spatie/laravel-route-discovery Auto register routes using PHP attributes 23645.0k2](/packages/spatie-laravel-route-discovery)[esign/laravel-conversions-api A laravel wrapper package around the Facebook Conversions API 69145.4k](/packages/esign-laravel-conversions-api)[didww/didww-api-3-php-sdk PHP SDK for DIDWW API 3 1218.2k](/packages/didww-didww-api-3-php-sdk)[surface/laravel-webfinger A Laravel package to create an ActivityPub webfinger. 113.8k](/packages/surface-laravel-webfinger) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)