店配作業 #
已出貨訂單查詢V2 #
- V2 相較於 V1，提供 更詳細的訂單資訊，新增內容請參考下方列表。
- Endpoint 與 V1 相同
- 僅需於 Request Headers 中新增以下設定，即可使用 V2：
api-version: 2，即可取得對應的訂單資訊。
- 訂單查詢相關API提供不同版本以滿足不同的資訊需求，目前最新為 V3 版本，具備所有點數折抵資訊。以下為各版本說明：
版本說明 #
| 版本 | Header 設定 | 差異說明 |
|---|---|---|
| V1 | 無需額外設定 | 提供基本訂單出貨資訊 |
| V2 | "api-version": "2" |
增加賣場活動折抵、折價卷、購物金、超贈點、福利金等資訊 |
| V3 | "api-version": "3" |
在 V2 的基礎上新增 OPENPOINT 點數折抵資訊 |
Headers 範例
{
"api-token": "Supplier_XXXX",
"api-supplierid": "XXXX",
"content-type": "application/json",
"accept": "application/json",
"api-version": "2"
}
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 /scmapi/api/StoreDelivery/GetShippingOrders
{
"TransferDateStart": "2024-10-15T11:00:00",
"TransferDateEnd": "2024-10-28T11:21:55"
}
{
"OrderCount": 7,
"Orders": [
{
"OrderInfo": {
"ExternOrderkey": 504552571,
"OrderCode": "RM2410160000002",
"OrderType": null,
"TransferDate": "2024-10-16T10:06:04.93",
"ExpectedShippingDate": "2024-10-17T23:59:00",
"LastShippingDate": "2024-10-17T23:59:00",
"Note": "",
"ShippingDate": "2024-10-17T00:00:00",
"DeliveryDate": "2024-11-01T14:52:00",
"Status": "完成出貨"
},
"ReceiverInfo": {
"Name": "葉思玗",
"Mobile": "0979102082"
},
"StoreInfo": {
"Type": "超商付款取貨(7-11)",
"Name": "新福玉門市",
"Id": "164641"
},
"LabelInfo": {},
"Products": [
{
"Id": 6920000,
"Name": "[供應商宅配運費]測試賣場4866-有活動(可單退)",
"Attribute": "",
"ItemPageId": 3453793,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 50,
"Subtotal": 50,
"ProductPrice": 199,
"RetailPrice": 398,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504552571,
"OrderCode": "RM2410160000001",
"OrderType": null,
"TransferDate": "2024-10-16T10:06:04.93",
"ExpectedShippingDate": "2024-10-17T23:59:00",
"LastShippingDate": "2024-10-17T23:59:00",
"Note": "",
"ShippingDate": "2024-10-17T00:00:00",
"DeliveryDate": "2024-11-01T14:52:00",
"Status": "完成出貨"
},
"ReceiverInfo": {
"Name": "葉思玗",
"Mobile": "0979102082"
},
"StoreInfo": {
"Type": "超商付款取貨(7-11)",
"Name": "新福玉門市",
"Id": "164641"
},
"LabelInfo": {},
"Products": [
{
"Id": 6908338,
"Name": "物流服務費",
"Attribute": "",
"ItemPageId": 3451246,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 50,
"Subtotal": 50,
"ProductPrice": 50,
"RetailPrice": 80,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504552580,
"OrderCode": "RM2410160000005",
"OrderType": null,
"TransferDate": "2024-10-16T10:46:28.047",
"ExpectedShippingDate": "2024-10-17T23:59:00",
"LastShippingDate": "2024-10-17T23:59:00",
"Note": "",
"ShippingDate": "2024-10-17T00:00:00",
"DeliveryDate": "2024-11-01T14:52:00",
"Status": "完成出貨"
},
"ReceiverInfo": {
"Name": "葉思玗",
"Mobile": "0979102082"
},
"StoreInfo": {
"Type": "超商付款取貨(7-11)",
"Name": "忠林門市",
"Id": "144315"
},
"LabelInfo": {},
"Products": [
{
"Id": 6926237,
"Name": "[供應商宅配運費]測試賣場",
"Attribute": "",
"ItemPageId": 3455365,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 50,
"Subtotal": 50,
"ProductPrice": 599,
"RetailPrice": 699,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504553125,
"OrderCode": "RM2410160000721",
"OrderType": null,
"TransferDate": "2024-10-16T11:21:40.247",
"ExpectedShippingDate": "2024-10-17T23:59:00",
"LastShippingDate": "2024-10-17T23:59:00",
"Note": "",
"ShippingDate": "2024-10-17T00:00:00",
"DeliveryDate": "2024-11-01T14:52:00",
"Status": "完成出貨"
},
"ReceiverInfo": {
"Name": "葉思玗",
"Mobile": "0979102082"
},
"StoreInfo": {
"Type": "超商付款取貨(7-11)",
"Name": "忠林門市",
"Id": "144315"
},
"LabelInfo": {},
"Products": [
{
"Id": 6908338,
"Name": "物流服務費",
"Attribute": "",
"ItemPageId": 3451246,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 50,
"Subtotal": 50,
"ProductPrice": 50,
"RetailPrice": 80,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504553125,
"OrderCode": "RM2410160000722",
"OrderType": null,
"TransferDate": "2024-10-16T11:21:40.247",
"ExpectedShippingDate": "2024-10-17T23:59:00",
"LastShippingDate": "2024-10-17T23:59:00",
"Note": "",
"ShippingDate": "2024-10-17T00:00:00",
"DeliveryDate": "2024-11-01T14:52:00",
"Status": "完成出貨"
},
"ReceiverInfo": {
"Name": "葉思玗",
"Mobile": "0979102082"
},
"StoreInfo": {
"Type": "超商付款取貨(7-11)",
"Name": "忠林門市",
"Id": "144315"
},
"LabelInfo": {},
"Products": [
{
"Id": 6920000,
"Name": "[供應商宅配運費]測試賣場4866-有活動(可單退)",
"Attribute": "",
"ItemPageId": 3453793,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 50,
"Subtotal": 50,
"ProductPrice": 199,
"RetailPrice": 398,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504558217,
"OrderCode": "RM2410180001026",
"OrderType": null,
"TransferDate": "2024-10-18T11:04:30.03",
"ExpectedShippingDate": "2024-10-21T23:59:00",
"LastShippingDate": "2024-10-21T23:59:00",
"Note": "",
"ShippingDate": "2024-10-19T00:00:00",
"DeliveryDate": "2024-10-17T11:34:00",
"Status": "完成出貨"
},
"ReceiverInfo": {
"Name": "陳菁如",
"Mobile": "0958265179"
},
"StoreInfo": {
"Type": "超商付款取貨(全家)",
"Name": "全家大東店",
"Id": "F019959"
},
"LabelInfo": {
"FirstBarcode": "836M836000021123",
"RoutingBarcode": "1HG11",
"PickupEShopBarcode": "836047910",
"PickupCodBarcode": "0170001510027219",
"PickupLogisticCode": "183600047017000150",
"LogisticCode": "18360004701700015",
"LogisticCheckSum": "0",
"QrCode": "B1|| || || || ||183600047017000150||2||020382||1HG11|| #||0||836047910||0170001510027219|| || ",
"StoreEquimentId": "#",
"StoreRegion": "北",
"StoreRoute": "HG",
"StoreRouteTrim": "11",
"ReturnPeriod": "週三",
"ReturnType": "宅配通",
"MobilePhone": "179",
"ConvenienceStoreId": "F019959",
"ConvenienceStoreName": "大東店",
"OrderInformation": "0",
"LogisticOrderNumber": "04701700015",
"DistributionCenter": "DRE",
"CustomerInformation": "(02)7723-8585 / tw.buy.yahoo.com",
"Remark": "請收款結帳",
"OfficialName": "雅虎購物"
},
"Products": [
{
"Id": 6926379,
"Name": "[供應商宅店配運費]測試賣場",
"Attribute": "",
"ItemPageId": 3455382,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 50,
"Subtotal": 50,
"ProductPrice": 388,
"RetailPrice": 399,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55887",
"ActivityAmount": 115,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504558217,
"OrderCode": "RM2410180001027",
"OrderType": null,
"TransferDate": "2024-10-18T11:04:30.483",
"ExpectedShippingDate": "2024-10-21T23:59:00",
"LastShippingDate": "2024-10-21T23:59:00",
"Note": "",
"ShippingDate": "2024-10-19T00:00:00",
"DeliveryDate": "2024-10-17T11:34:00",
"Status": "完成出貨"
},
"ReceiverInfo": {
"Name": "陳菁如",
"Mobile": "0958265179"
},
"StoreInfo": {
"Type": "超商付款取貨(全家)",
"Name": "全家大東店",
"Id": "F019959"
},
"LabelInfo": {
"FirstBarcode": "836M836000021124",
"RoutingBarcode": "1HG11",
"PickupEShopBarcode": "836047910",
"PickupCodBarcode": "0170001610026694",
"PickupLogisticCode": "183600047017000161",
"LogisticCode": "18360004701700016",
"LogisticCheckSum": "1",
"QrCode": "B1|| || || || ||183600047017000161||2||020382||1HG11|| #||0||836047910||0170001610026694|| || ",
"StoreEquimentId": "#",
"StoreRegion": "北",
"StoreRoute": "HG",
"StoreRouteTrim": "11",
"ReturnPeriod": "週三",
"ReturnType": "宅配通",
"MobilePhone": "179",
"ConvenienceStoreId": "F019959",
"ConvenienceStoreName": "大東店",
"OrderInformation": "0",
"LogisticOrderNumber": "04701700016",
"DistributionCenter": "DRE",
"CustomerInformation": "(02)7723-8585 / tw.buy.yahoo.com",
"Remark": "請收款結帳",
"OfficialName": "雅虎購物"
},
"Products": [
{
"Id": 6926236,
"Name": "[供應商宅店配運費]測試賣場",
"Attribute": "",
"ItemPageId": 3455364,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 50,
"Subtotal": 50,
"ProductPrice": 380,
"RetailPrice": 399,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55887",
"ActivityAmount": 114,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
}
]
}
Response Elements #
若操作成功，API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的已出貨清單。
OrderCount #
資料筆數。
資料型態: Integer
Orders #
顯示已出貨清單的內容。Orders 的結構分別說明如下：
- OrderInfo：訂單相關資訊
- ReceiverInfo：收件人相關資訊
- StoreInfo：超商相關資訊
- LabelInfo：標籤相關資訊(僅全家)
- Products：商品相關資訊
資料型態: Object Array
OrderInfo #
顯示訂單相關資訊的內容。OrderInfo 的結構分別說明如下：
- ExternOrderkey：購物車序號
- OrderCode：訂單編號
- OrderType：訂單類型
- TransferDate：轉單日期
- ExpectedShippingDate：應出貨日
- LastShippingDate：最晚出貨日
- Note：訂單備註
- ShippingDate：出貨確認日
- DeliveryDate：物流商配達日
- Status：出貨狀態
資料型態: Object
ExternOrderkey #
購物車序號。
資料型態: Integer
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：商品屬性
- ItemPageId：賣場編號
- SupplierNo：供應商料號
- Type：商品類別
- Qty：商品數量
- Cost：商品成本
- Subtotal：商品成本小計
- ProductPrice：商品售價
- RetailPrice：商品建議售價
- CouponActivityCode：折價券活動代號
- CouponAmount：折價券活動折抵金額
- ActivityCode：促銷折價活動代號
- ActivityAmount：促銷折價活動折抵金額
- RedeemAmout：消費者YAHOO購物金折抵金額
- RewardAmount：消費者YAHOO超贈點折抵金額
- WelfareAmount：消費者YAHOO福利金折抵金額
資料型態: Object
Id #
商品編號。
資料型態: Integer
Name #
商品名稱。
資料型態: String
Attribute #
商品屬性。
資料型態: String
ItemPageId #
賣場編號。
資料型態: Integer
SupplierNo #
供應商料號。
資料型態: String
Type #
商品類別。
資料型態: String
Qty #
商品數量。
資料型態: Integer
Cost #
商品成本。
資料型態: Integer
Subtotal #
商品成本小計。
資料型態: Integer
ProductPrice #
商品售價。
資料型態: Integer
RetailPrice #
商品建議售價。
資料型態: Integer
CouponActivityCode #
折價券活動代號。
資料型態: String
CouponAmount #
折價券活動折抵金額。
資料型態: Integer
ActivityCode #
促銷折價活動代號。
資料型態: String
ActivityAmount #
促銷折價活動折抵金額。
資料型態: Integer
RedeemAmout #
消費者YAHOO購物金折抵金額。
資料型態: Integer
RewardAmount #
消費者YAHOO超贈點折抵金額。
資料型態: Integer
WelfareAmount #
消費者YAHOO福利金折抵金額 (現況已無該折抵金額活動)。
資料型態: Integer