店配作業 #

已出貨訂單查詢 #

查詢已完成出貨的訂單資訊，結果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/StoreDelivery/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 Request

POST /scmapi/api/StoreDelivery/GetShippingOrders

{
    "TransferDateStart": "2024-07-25T11:00:00",
    "TransferDateEnd": "2024-08-01T11:21:55"
}

POST Response

{
    "OrderCount": 2,
    "Orders": [
        {
            "OrderInfo": {
                "OrderCode": "RM2402170000034",
                "OrderType": null,
                "TransferDate": "2024-02-17T16:37:16.423",
                "ExpectedShippingDate": "2024-02-19T23:59:00",
                "LastShippingDate": "2024-02-19T23:59:00",
                "Note": "",
                "ShippingDate": "2024-02-18T00:00:00",
                "DeliveryDate": "2024-02-17T17:04:00",
                "Status": "完成出貨"
            },
            "ReceiverInfo": {
                "Name": "胡尚淳",
                "Mobile": "0979101111"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "泰昌門市",
                "Id": "997870"
            },
            "LabelInfo": {},
            "Products": [
                {
                    "Id": 6497187,
                    "Name": "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567891",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 0,
                    "Subtotal": 0,
                    "ProductPrice": 500
                },
                {
                    "Id": 6804909,
                    "Name": "贈品",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 0,
                    "Subtotal": 0,
                    "ProductPrice": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "OrderCode": "RM2402170000036",
                "OrderType": null,
                "TransferDate": "2024-02-17T17:08:53.487",
                "ExpectedShippingDate": "2024-02-19T23:59:00",
                "LastShippingDate": "2024-02-19T23:59:00",
                "Note": "",
                "ShippingDate": "2024-02-18T00:00:00",
                "DeliveryDate": "2024-02-17T17:17:00",
                "Status": "完成出貨"
            },
            "ReceiverInfo": {
                "Name": "胡尚淳",
                "Mobile": "0979101111"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(全家)",
                "Name": "全家永樂店",
                "Id": "F010875"
            },
            "LabelInfo": {
                "FirstBarcode": "836M836000021110",
                "RoutingBarcode": "1GB20",
                "PickupEShopBarcode": "836047910",
                "PickupCodBarcode": "0170000210050028",
                "PickupLogisticCode": "18360004701700002$",
                "LogisticCode": "18360004701700002",
                "LogisticCheckSum": "$",
                "QrCode": "B1||                  ||         ||                  ||               ||18360004701700002$||2||018592||1GB20|| 8||0||836047910||0170000210050028||             ||          ",
                "StoreEquimentId": "8",
                "StoreRegion": "北",
                "StoreRoute": "GB",
                "StoreRouteTrim": "20",
                "ReturnPeriod": "週三",
                "ReturnType": "宅配通",
                "MobilePhone": "111",
                "ConvenienceStoreId": "F010875",
                "ConvenienceStoreName": "永樂店",
                "OrderInformation": "0",
                "LogisticOrderNumber": "04701700002",
                "DistributionCenter": "DRE",
                "CustomerInformation": "(02)7723-8585 / tw.buy.yahoo.com",
                "Remark": "請收款結帳",
                "OfficialName": "雅虎購物"
            },
            "Products": [
                {
                    "Id": 6497187,
                    "Name": "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567891",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 0,
                    "Subtotal": 0,
                    "ProductPrice": 500
                },
                {
                    "Id": 6804909,
                    "Name": "贈品",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 0,
                    "Subtotal": 0,
                    "ProductPrice": 0
                }
            ]
        }
    ]
}

Response Elements #

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

OrderCount #

資料筆數。
資料型態: Integer

Orders #

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

OrderInfo：訂單相關資訊
ReceiverInfo：收件人相關資訊
StoreInfo：超商相關資訊
LabelInfo：標籤相關資訊(僅全家)
Products：商品相關資訊

資料型態: Object Array

OrderInfo #

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

OrderCode：訂單編號
OrderType：訂單類型
TransferDate：轉單日期
ExpectedShippingDate：應出貨日
LastShippingDate：最晚出貨日
Note：訂單備註
ShippingDate：出貨確認日
DeliveryDate：物流商配達日
Status：出貨狀態

資料型態: Object

OrderCode #

訂單編號。
資料型態: String

OrderType #

訂單類型。
資料型態: 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

DeliveryDate #

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

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

Status #

出貨狀態。
資料型態: String

ReceiverInfo #

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

Name：收件人姓名
Mobile：收件人手機

資料型態: Object

Name #

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

Mobile #

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

StoreInfo #

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

Type：超商類型
Name：取貨門市
Id：門市代號

資料型態: Object

Type #

超商類型。
資料型態: String

Name #

取貨門市。
資料型態: String

Id #

門市代號。
資料型態: String

LabelInfo #

顯示標籤條碼相關資訊的內容，僅有全家會顯示。

FirstBarcode：一段標（母代碼 + 配送編號）
RoutingBarcode：『理貨條碼(5)』
PickupEShopBarcode：『取貨條碼ㄧ(9)』
PickupCodBarcode：『取貨條碼二(16)』
PickupLogisticCode：『取件物流碼(18)』
LogisticCode：『物流編號(17)』
LogisticCheckSum：『物流檢核碼(1)』
QrCode：『QR Code的內容』
StoreEquimentId：門市設備代碼
StoreRegion：門市區域
StoreRoute：理貨路線
StoreRouteTrim：理貨路順
ReturnPeriod：退貨週期
ReturnType：退貨方式
MobilePhone：取貨人末3碼
ConvenienceStoreId：取貨店號
ConvenienceStoreName：取貨門市
OrderInformation：訂單資料（一起買序號+超商子代碼）
LogisticOrderNumber：日翊訂單編號
DistributionCenter：大物流代碼，固定為DRE
CustomerInformation：客服專線『(02)7723-8585 / tw.buy.yahoo.com』
Remark：收款備註
OfficialName：官網名稱，固定為『雅虎購物』

資料型態: Array

FirstBarcode #

一段標:母代碼 + 配送編號。
資料型態: String

RoutingBarcode #

僅全家物流交寄回覆該欄位資料『理貨條碼(5)』。
資料型態: String

PickupEShopBarcode #

僅全家物流交寄回覆該欄位資料『取貨條碼ㄧ(9)』。
資料型態: String

PickupCodBarcode #

僅全家物流交寄回覆該欄位資料『取貨條碼二(16)』。
資料型態: String

PickupLogisticCode #

僅全家物流交寄回覆該欄位資料『取件物流碼(18)』。
資料型態: String

LogisticCode #

僅全家物流交寄回覆該欄位資料『物流編號(17)』。
資料型態: String

LogisticCheckSum #

僅全家物流交寄回覆該欄位資料『物流檢核碼(1)』。
資料型態: String

QrCode #

僅全家物流交寄回覆該欄位資料『QR Code的內容』。
資料型態: String

StoreEquimentId #

門市設備代碼。
資料型態: String

StoreRegion #

門市區域。
資料型態: String

StoreRoute #

理貨路線。
資料型態: String

StoreRouteTrim #

理貨路順。
資料型態: String

ReturnPeriod #

退貨週期。
資料型態: String

ReturnType #

退貨方式。
資料型態: String

MobilePhone #

取貨人末3碼。
資料型態: String

ConvenienceStoreId #

取貨店號。
資料型態: String

ConvenienceStoreName #

取貨門市。
資料型態: String

OrderInformation #

訂單資料(一起買序號+超商子代碼)。
資料型態: String

LogisticOrderNumber #

日翊訂單編號。
資料型態: String

DistributionCenter #

大物流代碼，固定為DRE。
資料型態: String

CustomerInformation #

客服專線:(02)7723-8585 / tw.buy.yahoo.com。
資料型態: String

Remark #

收款備註:『請收款結帳』因為是『取貨付款』要標註為請收款結帳。
資料型態: String

OfficialName #

官網名稱，固定為『雅虎購物』。
資料型態: 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