直配作業 #
待出貨訂單查詢 #
直配待出貨訂單查詢。
- 訂單查詢相關API提供不同版本以滿足不同的資訊需求，目前最新為 V3 版本，具備所有點數折抵資訊。以下為各版本說明：
版本說明 #
| 版本 | Header 設定 | 差異說明 |
|---|---|---|
| V1 | 無需額外設定 | 提供基本訂單出貨資訊 |
| V2 | "api-version": "2" |
增加賣場活動折抵、折價卷、購物金、超贈點、福利金等資訊 |
| V3 | "api-version": "3" |
在 V2 的基礎上新增 OPENPOINT 點數折抵資訊 |
Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/HomeDelivery/GetPreparingOrders
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/HomeDelivery/GetPreparingOrders
{
"TransferDateStart": "2024-01-22T13:00:00",
"TransferDateEnd": "2024-01-22T13:49:59"
}
{
"OrderCount": 9,
"Orders": [
{
"OrderInfo": {
"OrderCode": "RM2401220001122",
"TransferDate": "2024-01-22T13:44:11",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "(202)基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6449251,
"Name": "測試賣場，請勿購買007-3DS",
"Attribute": "3DS",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 1,
"Cost": 80,
"Subtotal": 80,
"ProductPrice": 1200
}
]
},
{
"OrderInfo": {
"OrderCode": "RM2401220001123",
"TransferDate": "2024-01-22T13:44:11",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "(202)基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6449261,
"Name": "測試賣場，請勿購買008-3DS",
"Attribute": "3DS",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 1,
"Cost": 80,
"Subtotal": 80,
"ProductPrice": 1200
}
]
},
{
"OrderInfo": {
"OrderCode": "RM2401220001227",
"TransferDate": "2024-01-22T13:44:28",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "(202)基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6439411,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439412,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439413,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439414,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439415,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439416,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439417,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439418,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6443078,
"Name": "酒蛋VVIP訂單測試",
"Attribute": "",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 1,
"Cost": 110,
"Subtotal": 110,
"ProductPrice": 1180
}
]
},
{
"OrderInfo": {
"OrderCode": "RM2401220001229",
"TransferDate": "2024-01-22T13:44:34",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "(202)基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6439411,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439412,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439413,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439414,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439415,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439416,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439417,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439418,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6443078,
"Name": "酒蛋VVIP訂單測試",
"Attribute": "",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 1,
"Cost": 110,
"Subtotal": 110,
"ProductPrice": 1180
}
]
},
{
"OrderInfo": {
"OrderCode": "RM2401220001232",
"TransferDate": "2024-01-22T13:44:42",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "(202)基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6449251,
"Name": "測試賣場，請勿購買007-3DS",
"Attribute": "3DS",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 1,
"Cost": 80,
"Subtotal": 80,
"ProductPrice": 1200
}
]
},
{
"OrderInfo": {
"OrderCode": "RM2401220001233",
"TransferDate": "2024-01-22T13:44:42",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "(202)基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6449261,
"Name": "測試賣場，請勿購買008-3DS",
"Attribute": "3DS",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 1,
"Cost": 80,
"Subtotal": 80,
"ProductPrice": 1200
}
]
},
{
"OrderInfo": {
"OrderCode": "RM2401220001236",
"TransferDate": "2024-01-22T13:44:48",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "卡包收件人",
"Address": "(115)台北市南港區測試卡包收件人路1號",
"Phone": "02-23602222",
"Mobile": "0905222222"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6439411,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439412,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439413,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439414,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439415,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439416,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439417,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6439418,
"Name": "測試贈品，請勿購買",
"Attribute": "",
"SupplierNo": "",
"Type": "一般商品",
"Qty": 1,
"Cost": 0,
"Subtotal": 0,
"ProductPrice": 0
},
{
"Id": 6443078,
"Name": "酒蛋VVIP訂單測試",
"Attribute": "",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 1,
"Cost": 110,
"Subtotal": 110,
"ProductPrice": 1180
}
]
},
{
"OrderInfo": {
"OrderCode": "RM2401220001247",
"TransferDate": "2024-01-22T13:45:01",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "(202)基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6454729,
"Name": "測試賣場，請勿購買003-3DS",
"Attribute": "3DS",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 2,
"Cost": 100,
"Subtotal": 200,
"ProductPrice": 1200
}
]
},
{
"OrderInfo": {
"OrderCode": "RM2401220001259",
"TransferDate": "2024-01-22T13:45:12",
"ExpectedShippingDate": "2024-01-23T23:59:00",
"LastShippingDate": "2024-01-23T23:59:00",
"Note": ""
},
"ReceiverInfo": {
"Name": "雅虎一",
"Address": "(202)基隆市中正區R三重路66號14樓",
"Phone": "02-23601111",
"Mobile": "0955121111"
},
"BuyerInfo": {
"Name": "雅虎零",
"Mobile": "0955120000"
},
"Products": [
{
"Id": 6458134,
"Name": "測試賣場，請勿購買",
"Attribute": "",
"SupplierNo": "A1234567890",
"Type": "一般商品",
"Qty": 2,
"Cost": 100,
"Subtotal": 200,
"ProductPrice": 449
}
]
}
]
}
Response Elements #
若操作成功，API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的待出貨清單。
OrderCount #
資料筆數。
資料型態: Integer
Orders #
顯示待出貨清單的內容。Orders 的結構分別說明如下：
- OrderInfo：訂單相關資訊
- ReceiverInfo：收件人相關資訊
- BuyerInfo：購買人相關資訊
- Products：商品相關資訊
資料型態: Object Array
OrderInfo #
顯示訂單相關資訊的內容。OrderInfo 的結構分別說明如下：
- OrderCode：訂單編號
- TransferDate：轉單日期
- ExpectedShippingDate：應出貨日
- LastShippingDate：最晚出貨日
- Note：訂單備註
資料型態: Object
OrderCode #
訂單編號。
資料型態: 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
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