已出貨訂單查詢

三方作業 #

已出貨訂單查詢 #

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

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

版本說明 #

版本 Header 設定 差異說明
V1 無需額外設定 提供基本訂單出貨資訊
V2 "api-version": "2" 增加賣場活動折抵、折價卷、購物金、超贈點、福利金等資訊
V3 "api-version": "3" 在 V2 的基礎上新增 OPENPOINT 點數折抵資訊

Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/ThirdPartyDelivery/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/ThirdPartyDelivery/GetShippingOrders

{
    "TransferDateStart": "2024-07-03T13:00:00",
    "TransferDateEnd": "2024-07-04T13:49:59"
}

{
    "OrderCount": 3,
    "Orders": [
        {
            "OrderInfo": {
                "OrderCode": "RM2405280000033",
                "ShipmentNos": [
                    "100172195165"
                ],
                "TransporterId": 11,
                "LocationOfficeId": "0",
                "LocationOfficeName": "",
                "TransferDate": "2024-05-28T09:15:31",
                "ExpectedShippingDate": "2024-05-29T23:59:00",
                "LastShippingDate": "2024-05-29T23:59:00",
                "ShippingDate": "2024-07-03T17:14:37.497",
                "DeliveryDate": "1900-01-01T00:00:00",
                "Note": ""
            },
            "ReceiverInfo": {
                "Name": "雅虎一",
                "Address": "(202)基隆市中正區R三重路66號14樓",
                "Phone": "02-23601111",
                "Mobile": "0955121111"
            },
            "BuyerInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "Products": [
                {
                    "Id": 6828224,
                    "Name": "[3D驗證]測試賣場-要走3D",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 800,
                    "Subtotal": 800,
                    "ProductPrice": 1000
                }
            ]
        },
        {
            "OrderInfo": {
                "OrderCode": "RM2407030000014",
                "ShipmentNos": [
                    "1000003745"
                ],
                "TransporterId": 4,
                "LocationOfficeId": " 45||||^045000000^|||",
                "LocationOfficeName": "",
                "TransferDate": "2024-07-03T10:49:14",
                "ExpectedShippingDate": "2024-07-04T23:59:00",
                "LastShippingDate": "2024-07-04T23:59:00",
                "ShippingDate": "2024-07-03T17:14:37.747",
                "DeliveryDate": "1900-01-01T00:00:00",
                "Note": ""
            },
            "ReceiverInfo": {
                "Name": "王大頭",
                "Address": "(437)台中市大甲區喵喵路一段23號",
                "Phone": "09-79123456",
                "Mobile": "0979123456"
            },
            "BuyerInfo": {
                "Name": "王大頭",
                "Mobile": "0979123456"
            },
            "Products": [
                {
                    "Id": 6908338,
                    "Name": "物流服務費",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 80,
                    "Subtotal": 80,
                    "ProductPrice": 80
                }
            ]
        },
        {
            "OrderInfo": {
                "OrderCode": "RM2407030000015",
                "ShipmentNos": [
                    "1000003745"
                ],
                "TransporterId": 4,
                "LocationOfficeId": " 45||||^045000000^|||",
                "LocationOfficeName": "",
                "TransferDate": "2024-07-03T10:49:14",
                "ExpectedShippingDate": "2024-07-04T23:59:00",
                "LastShippingDate": "2024-07-04T23:59:00",
                "ShippingDate": "2024-07-03T17:14:37.747",
                "DeliveryDate": "1900-01-01T00:00:00",
                "Note": ""
            },
            "ReceiverInfo": {
                "Name": "王大頭",
                "Address": "(437)台中市大甲區喵喵路一段23號",
                "Phone": "09-79123456",
                "Mobile": "0979123456"
            },
            "BuyerInfo": {
                "Name": "王大頭",
                "Mobile": "0979123456"
            },
            "Products": [
                {
                    "Id": 6831314,
                    "Name": "[3D驗證]測試賣場-宅店配要走3D",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 1,
                    "Subtotal": 1,
                    "ProductPrice": 6
                }
            ]
        }
    ]
}

Response Elements #

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

OrderCount #

資料筆數。
資料型態: Integer

Orders #

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

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

資料型態: Object Array

OrderInfo #

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

  • OrderCode：訂單編號
  • ShipmentNos：出貨單號
  • TransporterId：貨運商代碼
  • LocationOfficeId：到貨區碼
  • LocationOfficeName：到貨區碼名稱
  • TransferDate：轉單日期
  • ExpectedShippingDate：應出貨日
  • LastShippingDate：最晚出貨日
  • ShippingDate：出貨確認日
  • DeliveryDate：物流送達日
  • Note：訂單備註

資料型態: Object

OrderCode #

訂單編號。
資料型態: String

ShipmentNos #

出貨單號。
資料型態: String Array

TransporterId #

貨運商代碼。
資料型態: String
說明：此為物流商代碼，會對應出貨物流商查詢的ShipperId欄位。

LocationOfficeId #

到貨區碼。
資料型態: String
說明：此為新竹物流專用欄位，非新竹物流會顯示0或空值。

LocationOfficeName #

到貨區碼名稱。
資料型態: 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
ShippingDate #

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

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

物流送達日。
資料型態: dateTime
說明: 時間格式為

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

訂單備註。
資料型態: String

ReceiverInfo #

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

  • Name：收件人姓名
  • Address：收件人地址
  • Phone：收件人電話
  • Mobile：收件人手機

資料型態: Object

Name #

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

Address #

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

Phone #

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

Mobile #

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

BuyerInfo #

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

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

資料型態: Object

Name #

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

Mobile #

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

Products #

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

  • Id：商品編號
  • Name：商品名稱
  • Attribute：商品屬性
  • SupplierNo：供應商料號
  • Type：商品類別
  • Qty：商品數量
  • Cost：商品成本
  • Subtotal：商品成本小計
  • ProductPrice：商品售價

資料型態: Object

Id #

商品編號。
資料型態: Integer

Name #

商品名稱。
資料型態: String

Attribute #

商品屬性。
資料型態: String

SupplierNo #

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

Type #

商品類別。
資料型態: String

Qty #

商品數量。
資料型態: Integer

Cost #

商品成本。
資料型態: Integer

Subtotal #

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

ProductPrice #

商品售價。
資料型態: Integer