三方作業 #
已出貨訂單查詢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/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-09-25T13:00:00",
"TransferDateEnd": "2024-09-30T13:49:59"
}
{
"OrderCount": 4,
"Orders": [
{
"OrderInfo": {
"ExternOrderkey": 504113932,
"OrderCode": "RM2407100000006",
"ShipmentNos": [
"1000004364"
],
"TransporterId": 4,
"LocationOfficeId": " 11||||^011000000^|||",
"LocationOfficeName": "",
"TransferDate": "2024-07-10T11:04:23",
"ExpectedShippingDate": "2024-07-11T23:59:00",
"LastShippingDate": "2024-07-11T23:59:00",
"ShippingDate": "2024-09-26T15:50:33.863",
"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": 6700841,
"Name": "滿額贈賣場-贈品不足-測試勿改",
"Attribute": "",
"ItemPageId": 3439081,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"Subtotal": 800,
"ProductPrice": 800,
"RetailPrice": 1000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55254",
"ActivityAmount": 63,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
},
{
"Id": 6700841,
"Name": "滿額贈賣場-贈品不足-測試勿改",
"Attribute": "",
"ItemPageId": 3439081,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"Subtotal": 800,
"ProductPrice": 800,
"RetailPrice": 1000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55254",
"ActivityAmount": 63,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
},
{
"Id": 6700841,
"Name": "滿額贈賣場-贈品不足-測試勿改",
"Attribute": "",
"ItemPageId": 3439081,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"Subtotal": 800,
"ProductPrice": 800,
"RetailPrice": 1000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55254",
"ActivityAmount": 62,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
},
{
"Id": 6700841,
"Name": "滿額贈賣場-贈品不足-測試勿改",
"Attribute": "",
"ItemPageId": 3439081,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 800,
"Subtotal": 800,
"ProductPrice": 800,
"RetailPrice": 1000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55254",
"ActivityAmount": 62,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504113933,
"OrderCode": "RM2407100000007",
"ShipmentNos": [
"1000004375"
],
"TransporterId": 4,
"LocationOfficeId": " 11||||^011000000^|||",
"LocationOfficeName": "",
"TransferDate": "2024-07-10T11:04:23",
"ExpectedShippingDate": "2024-07-11T23:59:00",
"LastShippingDate": "2024-07-11T23:59:00",
"ShippingDate": "2024-09-26T15:50:34.363",
"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": 6565582,
"Name": "WALLE測試賣場2020031201",
"Attribute": "",
"ItemPageId": 3439088,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 510,
"Subtotal": 510,
"ProductPrice": 700,
"RetailPrice": 1000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55255",
"ActivityAmount": 84,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
},
{
"Id": 6565582,
"Name": "WALLE測試賣場2020031201",
"Attribute": "",
"ItemPageId": 3439088,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 510,
"Subtotal": 510,
"ProductPrice": 700,
"RetailPrice": 1000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55255",
"ActivityAmount": 83,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
},
{
"Id": 6565582,
"Name": "WALLE測試賣場2020031201",
"Attribute": "",
"ItemPageId": 3439088,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 510,
"Subtotal": 510,
"ProductPrice": 700,
"RetailPrice": 1000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "pca_55255",
"ActivityAmount": 83,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504521483,
"OrderCode": "RM2409260001775",
"ShipmentNos": [
"1000004386"
],
"TransporterId": 4,
"LocationOfficeId": " 33||||^033000000^|||",
"LocationOfficeName": "",
"TransferDate": "2024-09-26T15:29:20",
"ExpectedShippingDate": "2024-09-27T23:59:00",
"LastShippingDate": "2024-09-27T23:59:00",
"ShippingDate": "2024-09-26T15:50:34.397",
"DeliveryDate": "1900-01-01T00:00:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "非北北基",
"Address": "(351)苗栗縣頭份鎮非北北基一段50號",
"Phone": "09-00111222",
"Mobile": "0900111222"
},
"BuyerInfo": {
"Name": "胡尚淳",
"Mobile": "0979101111"
},
"Products": [
{
"Id": 6497166,
"Name": "Apple Pay 測試一般賣場-Fisher費雪",
"Attribute": "Fisher費雪",
"ItemPageId": 3369632,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 400,
"RetailPrice": 7000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
},
{
"Id": 6567453,
"Name": "贈品測試標準",
"Attribute": "",
"ItemPageId": 3369632,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0,
"RetailPrice": 7000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
}
]
},
{
"OrderInfo": {
"ExternOrderkey": 504521485,
"OrderCode": "RM2409260001777",
"ShipmentNos": [
"1000004390"
],
"TransporterId": 4,
"LocationOfficeId": " 33||||^033000000^|||",
"LocationOfficeName": "",
"TransferDate": "2024-09-26T15:30:11",
"ExpectedShippingDate": "2024-09-27T23:59:00",
"LastShippingDate": "2024-09-27T23:59:00",
"ShippingDate": "2024-09-26T15:50:34.427",
"DeliveryDate": "1900-01-01T00:00:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "非北北基",
"Address": "(351)苗栗縣頭份鎮非北北基一段50號",
"Phone": "09-00111222",
"Mobile": "0900111222"
},
"BuyerInfo": {
"Name": "胡尚淳",
"Mobile": "0979101111"
},
"Products": [
{
"Id": 6497166,
"Name": "Apple Pay 測試一般賣場-Fisher費雪",
"Attribute": "Fisher費雪",
"ItemPageId": 3369632,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 400,
"RetailPrice": 7000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 0,
"RewardAmount": 0,
"WelfareAmount": 0
},
{
"Id": 6567453,
"Name": "贈品測試標準",
"Attribute": "",
"ItemPageId": 3369632,
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0,
"RetailPrice": 7000,
"CouponActivityCode": "",
"CouponAmount": 0,
"ActivityCode": "",
"ActivityAmount": 0,
"RedeemAmout": 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：訂單編號
- ShipmentNos：出貨單號
- TransporterId：貨運商代碼
- LocationOfficeId：到貨區碼
- LocationOfficeName：到貨區碼名稱
- TransferDate：轉單日期
- ExpectedShippingDate：應出貨日
- LastShippingDate：最晚出貨日
- ShippingDate：出貨確認日
- DeliveryDate：物流送達日
- Note：訂單備註
資料型態: Object
ExternOrderkey #
購物車序號。
資料型態: Integer
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：商品屬性
- 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