店配作業 #

待出貨訂單查詢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/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 Request

POST /scmapi/api/StoreDelivery/GetPreparingOrders

{
  "TransferDateStart": "2024-09-30T15:20:00",
  "TransferDateEnd": "2024-09-30T15:50:55"
}

POST Response

{
    "OrderCount": 7,
    "Orders": [
        {
            "OrderInfo": {
                "ExternOrderkey": 504525629,
                "OrderCode": "RM2409300001609",
                "TransferDate": "2024-09-30T15:38:10.093",
                "OrderType": "一般賣場",
                "ExpectedShippingDate": "2024-10-01T23:59:00",
                "LastShippingDate": "2024-10-01T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": "0001-01-01T00:00:00"
            },
            "ReceiverInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "士東門市",
                "Id": "955348"
            },
            "Products": [
                {
                    "Id": 6448663,
                    "Name": "測試賣場，請勿購買",
                    "Attribute": "",
                    "ItemPageId": 3334103,
                    "SupplierNo": "A1234567890B1234567890",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 100,
                    "Subtotal": 100,
                    "ProductPrice": 1200,
                    "RetailPrice": 1200,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504525637,
                "OrderCode": "RM2409300001617",
                "TransferDate": "2024-09-30T15:38:45.427",
                "OrderType": "一般賣場",
                "ExpectedShippingDate": "2024-10-01T23:59:00",
                "LastShippingDate": "2024-10-01T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": "0001-01-01T00:00:00"
            },
            "ReceiverInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "士東門市",
                "Id": "955348"
            },
            "Products": [
                {
                    "Id": 6452791,
                    "Name": "測試賣場，請勿購買",
                    "Attribute": "",
                    "ItemPageId": 3335205,
                    "SupplierNo": "A1234567890",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 100,
                    "Subtotal": 100,
                    "ProductPrice": 1200,
                    "RetailPrice": 1200,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504525638,
                "OrderCode": "RM2409300001618",
                "TransferDate": "2024-09-30T15:38:45.49",
                "OrderType": "一般賣場",
                "ExpectedShippingDate": "2024-10-01T23:59:00",
                "LastShippingDate": "2024-10-01T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": "0001-01-01T00:00:00"
            },
            "ReceiverInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "士東門市",
                "Id": "955348"
            },
            "Products": [
                {
                    "Id": 6452791,
                    "Name": "測試賣場，請勿購買",
                    "Attribute": "",
                    "ItemPageId": 3335205,
                    "SupplierNo": "A1234567890",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 100,
                    "Subtotal": 100,
                    "ProductPrice": 1200,
                    "RetailPrice": 1200,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504525641,
                "OrderCode": "RM2409300001621",
                "TransferDate": "2024-09-30T15:38:55.657",
                "OrderType": "一般賣場",
                "ExpectedShippingDate": "2024-10-01T23:59:00",
                "LastShippingDate": "2024-10-01T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": "0001-01-01T00:00:00"
            },
            "ReceiverInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "士東門市",
                "Id": "955348"
            },
            "Products": [
                {
                    "Id": 6452791,
                    "Name": "測試賣場，請勿購買",
                    "Attribute": "",
                    "ItemPageId": 3335205,
                    "SupplierNo": "A1234567890",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 100,
                    "Subtotal": 100,
                    "ProductPrice": 1200,
                    "RetailPrice": 1200,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504525643,
                "OrderCode": "RM2409300001623",
                "TransferDate": "2024-09-30T15:39:00.707",
                "OrderType": "一般賣場",
                "ExpectedShippingDate": "2024-10-01T23:59:00",
                "LastShippingDate": "2024-10-01T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": "0001-01-01T00:00:00"
            },
            "ReceiverInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "士東門市",
                "Id": "955348"
            },
            "Products": [
                {
                    "Id": 6452791,
                    "Name": "測試賣場，請勿購買",
                    "Attribute": "",
                    "ItemPageId": 3335205,
                    "SupplierNo": "A1234567890",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 100,
                    "Subtotal": 100,
                    "ProductPrice": 1200,
                    "RetailPrice": 1200,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504525663,
                "OrderCode": "RM2409300001646",
                "TransferDate": "2024-09-30T15:40:26.553",
                "OrderType": "一般賣場",
                "ExpectedShippingDate": "2024-10-01T23:59:00",
                "LastShippingDate": "2024-10-01T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": "0001-01-01T00:00:00"
            },
            "ReceiverInfo": {
                "Name": "快結訂購人",
                "Mobile": "0955333333"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "池上門市",
                "Id": "110677"
            },
            "Products": [
                {
                    "Id": 6452791,
                    "Name": "測試賣場，請勿購買",
                    "Attribute": "",
                    "ItemPageId": 3335205,
                    "SupplierNo": "A1234567890",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 100,
                    "Subtotal": 100,
                    "ProductPrice": 1200,
                    "RetailPrice": 1200,
                    "CouponActivityCode": "",
                    "CouponAmount": 0,
                    "ActivityCode": "",
                    "ActivityAmount": 0,
                    "RedeemAmout": 0,
                    "RewardAmount": 0,
                    "WelfareAmount": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "ExternOrderkey": 504525669,
                "OrderCode": "RM2409300001652",
                "TransferDate": "2024-09-30T15:40:46.79",
                "OrderType": "一般賣場",
                "ExpectedShippingDate": "2024-10-01T23:59:00",
                "LastShippingDate": "2024-10-01T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": "0001-01-01T00:00:00"
            },
            "ReceiverInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "士東門市",
                "Id": "955348"
            },
            "Products": [
                {
                    "Id": 6452791,
                    "Name": "測試賣場，請勿購買",
                    "Attribute": "",
                    "ItemPageId": 3335205,
                    "SupplierNo": "A1234567890",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 100,
                    "Subtotal": 100,
                    "ProductPrice": 1200,
                    "RetailPrice": 1200,
                    "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：收件人相關資訊
StoreInfo：超商相關資訊
Products：商品相關資訊

資料型態: Object Array

OrderInfo #

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

ExternOrderkey：購物車序號
OrderCode：訂單編號
TransferDate：轉單日期
OrderType：賣場類型
ExpectedShippingDate：應出貨日
LastShippingDate：最晚出貨日
Note：訂單備註
ShippingDate：出貨確認日
DeliveryDate：物流商配達日

資料型態: Object

ExternOrderkey #

購物車序號。
資料型態: Integer

OrderCode #

訂單編號。
資料型態: String

TransferDate #

轉單日期。
資料型態: dateTime
說明: 時間格式為

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

OrderType #

賣場類型。
資料型態: String

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

ReceiverInfo #

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

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

資料型態: Object

Name #

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

Mobile #

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

StoreInfo #

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

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

資料型態: Object

Type #

超商類型。
資料型態: String

Name #

取貨門市。
資料型態: String

Id #

門市代號。
資料型態: 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