已出貨訂單查詢

集宅配作業 #

已出貨訂單查詢 #

查詢已完成出貨的訂單資訊，結果Cache 10分鐘。

  • 訂單查詢相關API提供不同版本以滿足不同的資訊需求，目前最新為 V3 版本，具備所有點數折抵資訊。以下為各版本說明：

版本說明 #

版本 Header 設定 差異說明
V1 無需額外設定 提供基本的分包訂單資訊包含賣場活動折抵、折價卷、購物金、超贈點、福利金等
V2 "api-version": "2" 在 V1 基礎上 新增 OPEN POINT 折抵金額資訊
V3 "api-version": "3" 與 V2 相同，未來預計以 V3 為主線版本，建議新接入使用

Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/ExpressDelivery/GetShippingOrders
HTTP Method: POST

Request Body #

TransferDateStart #

轉單日 (起)。
資料型態: dateTime
必填: 是
說明: 時間格式為

  • yyyy-mm-ddThh:mm:ss
  • ex. 2024-01-20T00:00:00

TransferDateEnd #

轉單日 (迄)。
資料型態: dateTime
必填: 是
說明: 時間格式為

  • yyyy-mm-ddThh:mm:ss
  • ex. 2024-01-25T23:59:59

Request/Response Sample #

POST /scmapi/api/ExpressDelivery/GetShippingOrders

{
    "TransferDateStart": "2024-08-20T11:00:00",
    "TransferDateEnd": "2024-10-22T11:21:55"
}

{
    "OrderCount": 5,
    "Orders": [
        {
            "OrderInfo": {
                "ExternOrderkey": 504487357,
                "OrderCode": "RM2408210000025",
                "TransferDate": "2024-08-21T12:49:29.837",
                "ExpectedShippingDate": "1900-01-01T00:00:00",
                "LastShippingDate": "1900-01-01T00:00:00",
                "Note": "",
                "ShippingDate": "2024-08-20T14:49:00"
            },
            "ReceiverInfo": {
                "Name": "aaa",
                "Address": "(104)台北市中山區天龍路18號",
                "Phone": "09-78237469",
                "Mobile": "0978237469",
                "CVSType": "LINE Pay",
                "StoreName": "",
                "StoreId": ""
            },
            "BuyerInfo": {
                "Name": "楚中天",
                "Mobile": "0979123456"
            },
            "Products": [
                {
                    "Id": 6490535,
                    "Name": "caa 的測試賣場 002",
                    "Attribute": "",
                    "ItemPageId": 3367444,
                    "SupplierNo": "",
                    "Type": "集宅配(24小時)",
                    "BuyOut": "N",
                    "Qty": 1,
                    "Cost": 1,
                    "Subtotal": 1,
                    "ProductPrice": 600,
                    "RetailPrice": 999999,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0,
                    "WareHouse": "大溪"
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504499184,
                "OrderCode": "RM2409020001555",
                "TransferDate": "2024-09-02T17:30:58.477",
                "ExpectedShippingDate": "1900-01-01T00:00:00",
                "LastShippingDate": "1900-01-01T00:00:00",
                "Note": "",
                "ShippingDate": "2024-09-01T19:31:00"
            },
            "ReceiverInfo": {
                "Name": "張大王",
                "Address": "(320)桃園市中壢區中正路199號",
                "Phone": "09-79102257",
                "Mobile": "0979102257",
                "CVSType": "LINE Pay",
                "StoreName": "",
                "StoreId": ""
            },
            "BuyerInfo": {
                "Name": "JJJ",
                "Mobile": "0912345678"
            },
            "Products": [
                {
                    "Id": 6488582,
                    "Name": "[Vitali] 無屬性 1",
                    "Attribute": "",
                    "ItemPageId": 3366793,
                    "SupplierNo": "",
                    "Type": "集宅配(24小時)",
                    "BuyOut": "N",
                    "Qty": 1,
                    "Cost": 1,
                    "Subtotal": 1,
                    "ProductPrice": 500,
                    "RetailPrice": 9999999,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "com_51170_a30f8a16f720",
                    "ActivityAmount": 100,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0,
                    "WareHouse": "大溪"
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504499184,
                "OrderCode": "RM2409020001556",
                "TransferDate": "2024-09-02T17:30:58.587",
                "ExpectedShippingDate": "1900-01-01T00:00:00",
                "LastShippingDate": "1900-01-01T00:00:00",
                "Note": "",
                "ShippingDate": "2024-09-01T19:31:00"
            },
            "ReceiverInfo": {
                "Name": "張大王",
                "Address": "(320)桃園市中壢區中正路199號",
                "Phone": "09-79102257",
                "Mobile": "0979102257",
                "CVSType": "LINE Pay",
                "StoreName": "",
                "StoreId": ""
            },
            "BuyerInfo": {
                "Name": "JJJ",
                "Mobile": "0912345678"
            },
            "Products": [
                {
                    "Id": 6488585,
                    "Name": "[Vitali] 廢四機",
                    "Attribute": "",
                    "ItemPageId": 3366796,
                    "SupplierNo": "",
                    "Type": "集宅配(24小時)",
                    "BuyOut": "N",
                    "Qty": 1,
                    "Cost": 1,
                    "Subtotal": 1,
                    "ProductPrice": 500,
                    "RetailPrice": 9999999,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "com_51170_a30f8a16f720",
                    "ActivityAmount": 90,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0,
                    "WareHouse": "大溪"
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504508850,
                "OrderCode": "RM2409190000937",
                "TransferDate": "2024-09-19T10:08:15.773",
                "ExpectedShippingDate": "2024-09-19T10:08:00",
                "LastShippingDate": "2024-09-19T10:08:00",
                "Note": "",
                "ShippingDate": "2024-09-18T12:08:00"
            },
            "ReceiverInfo": {
                "Name": "張煜志",
                "Address": "()F012793｜全家三峽新莉雅店｜新北市三峽區二鬮路59之1號1樓",
                "Phone": "09-78102259",
                "Mobile": "0979102257",
                "CVSType": "超商付款取貨(全家)",
                "StoreName": "全家三峽新莉雅店",
                "StoreId": "F012793"
            },
            "BuyerInfo": {
                "Name": "張煜志",
                "Mobile": "0979102257"
            },
            "Products": [
                {
                    "Id": 6490535,
                    "Name": "caa 的測試賣場 002",
                    "Attribute": "",
                    "ItemPageId": 3367444,
                    "SupplierNo": "",
                    "Type": "超商付款取貨(非24小時)",
                    "BuyOut": "N",
                    "Qty": 1,
                    "Cost": 1,
                    "Subtotal": 1,
                    "ProductPrice": 600,
                    "RetailPrice": 999999,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0,
                    "WareHouse": "大溪"
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504508851,
                "OrderCode": "RM2409190000938",
                "TransferDate": "2024-09-19T10:10:55.96",
                "ExpectedShippingDate": "2024-09-19T10:11:00",
                "LastShippingDate": "2024-09-19T10:11:00",
                "Note": "",
                "ShippingDate": "2024-09-18T12:11:00"
            },
            "ReceiverInfo": {
                "Name": "張煜志",
                "Address": "()F012793｜全家三峽新莉雅店｜新北市三峽區二鬮路59之1號1樓",
                "Phone": "09-78102259",
                "Mobile": "0979102257",
                "CVSType": "超商付款取貨(全家)",
                "StoreName": "全家三峽新莉雅店",
                "StoreId": "F012793"
            },
            "BuyerInfo": {
                "Name": "張煜志",
                "Mobile": "0979102257"
            },
            "Products": [
                {
                    "Id": 6490535,
                    "Name": "caa 的測試賣場 002",
                    "Attribute": "",
                    "ItemPageId": 3367444,
                    "SupplierNo": "",
                    "Type": "超商付款取貨(非24小時)",
                    "BuyOut": "N",
                    "Qty": 1,
                    "Cost": 1,
                    "Subtotal": 1,
                    "ProductPrice": 600,
                    "RetailPrice": 999999,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0,
                    "WareHouse": "大溪"
                }
            ]
        }
    ]
}

Response Elements #

若操作成功，API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的已出貨清單。

OrderCount #

資料筆數。
資料型態: Integer

Orders #

顯示已出貨清單的內容。Orders 的結構分別說明如下：

  • OrderInfo：訂單相關資訊
  • ReceiverInfo：收件人相關資訊
  • BuyerInfo：購買人相關資訊
  • Products：商品相關資訊

資料型態: Object Array

OrderInfo #

顯示訂單相關資訊的內容。OrderInfo 的結構分別說明如下：

  • ExternOrderkey：購物車序號
  • OrderCode：訂單編號
  • TransferDate：轉單日期
  • ExpectedShippingDate：應出貨日
  • LastShippingDate：最晚出貨日
  • Note：訂單備註
  • ShippingDate：訂單出貨日

資料型態: Object

ExternOrderkey #

購物車序號。
資料型態: Integer

OrderCode #

訂單編號。
資料型態: String

TransferDate #

轉單日期。
資料型態: dateTime
說明: 時間格式為

  • yyyy-mm-ddThh:mm:ss
  • ex. 2024-01-20T00:00:00
ExpectedShippingDate #

應出貨日。
資料型態: dateTime
說明: 時間格式為

  • yyyy-mm-ddThh:mm:ss
  • ex. 2024-01-20T00:00:00
LastShippingDate #

最晚出貨日。
資料型態: dateTime
說明: 時間格式為

  • yyyy-mm-ddThh:mm:ss
  • ex. 2024-01-20T00:00:00
Note #

訂單備註。
資料型態: String

ShippingDate #

訂單出貨日。
資料型態: dateTime
說明: 時間格式為

  • yyyy-mm-ddThh:mm:ss
  • ex. 2024-01-20T00:00:00

ReceiverInfo #

顯示收件人相關資訊的內容。ReceiverInfo 的結構分別說明如下：

  • Name：收件人姓名
  • Address：收件人地址
  • Phone：收件人電話
  • Mobile：收件人手機
  • CVSType：付款方式
  • StoreName：超商取貨店名
  • StoreId：超商取貨店號

資料型態: Object

Name #

收件人姓名。
資料型態: String

Address #

收件人地址。
資料型態: String

Phone #

收件人電話。
資料型態: String

Mobile #

收件人手機。
資料型態: String

CVSType #

付款方式。
資料型態: String

StoreName #

超商取貨店名。
資料型態: String

StoreId #

超商取貨店號。
資料型態: String

BuyerInfo #

顯示訂購人相關資訊的內容。BuyerInfo 的結構分別說明如下：

  • Name：訂購人姓名
  • Mobile：訂購人手機

資料型態: Object

Name #

收件人姓名。
資料型態: String

Mobile #

收件人手機。
資料型態: String

Products #

顯示商品相關資訊的內容。Products 的結構分別說明如下：

  • Id：商品編號
  • Name：商品名稱
  • Attribute：商品屬性
  • ItemPageId：賣場編號
  • SupplierNo：供應商料號
  • Type：商品類別
  • BuyOut：是否買斷商品
  • Qty：商品數量
  • Cost：商品成本
  • Subtotal：商品成本小計
  • ProductPrice：商品售價
  • RetailPrice：建議售價
  • CouponActivityCode：折價券活動代碼
  • CouponAmount：折價券折抵金額
  • ActivityCode：促銷活動代碼
  • ActivityAmount：促銷折抵金額
  • RedeemAmout：購物金折抵金額
  • RewardAmount：超贈點折抵金額
  • WelfareAmount：福利金折抵金額
  • WareHouse：出貨倉別

資料型態: Object

Id #

商品編號。
資料型態: Integer

Name #

商品名稱。
資料型態: String

Attribute #

商品屬性。
資料型態: String

ItemPageId #

賣場編號。
資料型態: Integer

SupplierNo #

供應商料號。
資料型態: String

Type #

商品類別。
資料型態: String
說明：

  • 24H快速到貨
  • 非24H快速到貨
  • 貨到付款
  • 超商取貨-711
  • 超商取貨-全家
BuyOut #

是否買斷商品。
資料型態: String
說明:

  • Y：買斷商品
  • N：非買斷商品
Qty #

商品數量。
資料型態: Integer

Cost #

商品成本。
資料型態: Integer

Subtotal #

商品成本小計。
資料型態: Integer

ProductPrice #

商品售價。
資料型態: Integer

RetailPrice #

建議售價。
資料型態: Integer

CouponActivityCode #

折價券活動代碼。
資料型態: String

CouponAmount #

折價券折抵金額。
資料型態: Integer

ActivityCode #

促銷活動代碼。
資料型態: String

ActivityAmount #

促銷折抵金額。
資料型態: Integer

RedeemAmout #

購物金折抵金額。
資料型態: Integer

RewardAmount #

超贈點折抵金額。
資料型態: Integer

WelfareAmount #

福利金折抵金額。
資料型態: Integer

WareHouse #

出貨倉別。
資料型態: String
說明：

  • 秋雨倉
  • 南崁倉
  • 大溪倉