三方作業 #
分包出貨-待出貨訂單查詢 #
- 本 API 用於查詢分包出貨情境下的待出貨訂單資訊，特別適用於 同一收件人與地址但因超材需分包出貨的情境。每筆商品會對應一組
OrderSubCode。📌 注意：此 API 與原三方物流 Group 功能不同，請務必確認
ThirdPartyLogistics是否正確。 - 訂單查詢相關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/ThirdPartyLogistics/ToBeShippedOrders
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/ThirdPartyLogistics/ToBeShippedOrders
{
"TransferDateStart": "2024-07-30T13:00:00",
"TransferDateEnd": "2024-07-30T14:15:55"
}
{
"OrderCount": 11,
"Orders": [
{
"OrderInfo": {
"ExternOrderkey": 504146236,
"OrderCode": "RM2407300001118",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:11",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002473",
"Id": 6828224,
"Name": "[3D驗證]測試賣場-要走3D",
"Attribute": "",
"ItemPageId": 3427411,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146241,
"OrderCode": "RM2407300001124",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:11",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002495",
"Id": 6828224,
"Name": "[3D驗證]測試賣場-要走3D",
"Attribute": "",
"ItemPageId": 3427411,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146247,
"OrderCode": "RM2407300001131",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:11",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002526",
"Id": 6828224,
"Name": "[3D驗證]測試賣場-要走3D",
"Attribute": "",
"ItemPageId": 3427411,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146255,
"OrderCode": "RM2407300001140",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:11",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002575",
"Id": 6828224,
"Name": "[3D驗證]測試賣場-要走3D",
"Attribute": "",
"ItemPageId": 3427411,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146262,
"OrderCode": "RM2407300001148",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:11",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002631",
"Id": 6828224,
"Name": "[3D驗證]測試賣場-要走3D",
"Attribute": "",
"ItemPageId": 3427411,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146270,
"OrderCode": "RM2407300001156",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:11",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002663",
"Id": 6828224,
"Name": "[3D驗證]測試賣場-要走3D",
"Attribute": "",
"ItemPageId": 3427411,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146280,
"OrderCode": "RM2407300001174",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:11",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002716",
"Id": 6828227,
"Name": "[3D驗證]測試賣場-不要走3D",
"Attribute": "",
"ItemPageId": 3427413,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 50,
"RewardAmount": 100,
"WelfareAmount": 75
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146280,
"OrderCode": "RM2407300001173",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:11",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002715",
"Id": 6828224,
"Name": "[3D驗證]測試賣場-要走3D",
"Attribute": "",
"ItemPageId": 3427411,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 50,
"RewardAmount": 100,
"WelfareAmount": 75
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146291,
"OrderCode": "RM2407300001197",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:12",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002782",
"Id": 6828227,
"Name": "[3D驗證]測試賣場-不要走3D",
"Attribute": "",
"ItemPageId": 3427413,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146291,
"OrderCode": "RM2407300001196",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:12",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300002781",
"Id": 6828224,
"Name": "[3D驗證]測試賣場-要走3D",
"Attribute": "",
"ItemPageId": 3427411,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"ProductPrice": 1000,
"RetailPrice": 1200,
"CouponActivityCode": "115623",
"CouponAmount": 10,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504146351,
"OrderCode": "RM2407300001292",
"TransporterId": 0,
"LocationOfficeId": null,
"LocationOfficeName": null,
"TransferDate": "2024-07-30T14:14:15",
"ExpectedShippingDate": "2024-07-31T23:59:00",
"LastShippingDate": "2024-07-31T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "202基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"OrderSubCode": "RS2407300003022",
"Id": 6471538,
"Name": "sb-int專用賣場-請勿修改",
"Attribute": "",
"ItemPageId": 3362387,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 110,
"ProductPrice": 1200,
"RetailPrice": 1200,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmount": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
}
]
}
Response Elements #
若操作成功，API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的待出貨清單。
OrderCount #
資料筆數。
資料型態: Integer
Orders #
顯示待出貨清單的內容。Orders 的結構分別說明如下：
- OrderInfo：訂單相關資訊
- ReceiverInfo：收件人相關資訊
- BuyerInfo：購買人相關資訊
- Products：商品相關資訊
資料型態: Object Array
OrderInfo #
顯示訂單相關資訊的內容。OrderInfo 的結構分別說明如下：
- ExternOrderkey：購物車序號
- OrderCode：訂單編號
- TransporterId：貨運商代碼
- LocationOfficeId：到貨區碼
- LocationOfficeName：到貨區碼名稱
- TransferDate：轉單日期
- ExpectedShippingDate：應出貨日
- LastShippingDate：最晚出貨日
- Note：訂單備註
資料型態: Object
ExternOrderkey #
購物車序號。
資料型態: Integer
OrderCode #
訂單編號。
資料型態: String
TransporterId #
貨運商代碼。
資料型態: Integer
說明: 未執行包裝/出貨確認前，此欄位會顯示0
LocationOfficeId #
到貨區碼。
資料型態: String
說明: 未執行包裝/出貨確認前，此欄位會顯示null
LocationOfficeName #
到貨區碼名稱。
資料型態: String
說明: 未執行包裝/出貨確認前，此欄位會顯示null
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
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 的結構分別說明如下：
- OrderSubCode：訂購子單編號
- Id：商品編號
- Name：商品名稱
- Attribute：商品屬性
- ItemPageId：上架商品編號
- SupplierNo：供應商料號
- Type：商品類別
- Qty：商品數量
- Cost：商品成本
- ProductPrice：商品售價
- RetailPrice：賣場建議售價
- CouponActivityCode：折價券活動代號
- CouponAmount：折價券活動折抵金額
- ActivityCode：促銷折價活動代號
- ActivityAmount：促銷折價活動折抵金額
- RedeemAmount：消費者YAHOO購物金折抵金額
- RewardAmount：消費者YAHOO超贈點折抵金額
- WelfareAmount：消費者YAHOO福利金折抵金額
資料型態: Object
OrderSubCode #
訂購子單編號。
資料型態: String
Id #
商品編號。
說明：後台系統商品編號。
資料型態: Integer
Name #
商品名稱。
資料型態: String
Attribute #
商品屬性。
資料型態: String
ItemPageId #
上架商品編號。
說明：賣場頁商品編號。
資料型態: Integer
SupplierNo #
供應商料號。
資料型態: String
Type #
商品類別。
資料型態: String
Qty #
商品數量。
資料型態: Integer
Cost #
商品成本。
資料型態: Integer
ProductPrice #
商品售價。
資料型態: Integer
RetailPrice #
賣場建議售價。
資料型態: Integer
CouponActivityCode #
折價券活動代號。
資料型態: String
CouponAmount #
折價券活動折抵金額。
資料型態: Integer
ActivityCode #
促銷折價活動代號。
資料型態: String
ActivityAmount #
促銷折價活動折抵金額。
資料型態: Integer
RedeemAmount #
消費者YAHOO購物金折抵金額。
資料型態: Integer
RewardAmount #
消費者YAHOO超贈點折抵金額。
資料型態: Integer
WelfareAmount #
消費者YAHOO福利金折抵金額(現況已無該折抵金額活動)。
資料型態: Integer