待出貨訂單查詢

店配作業 #

待出貨訂單查詢 #

店配待出貨訂單查詢。

  • 訂單查詢相關API提供不同版本以滿足不同的資訊需求，目前最新為 V3 版本，具備所有點數折抵資訊。以下為各版本說明：

版本說明 #

版本 Header 設定 差異說明
V1 無需額外設定 提供基本訂單出貨資訊
V2 "api-version": "2" 增加賣場活動折抵、折價卷、購物金、超贈點、福利金等資訊
V3 "api-version": "3" 在 V2 的基礎上新增 OPENPOINT 點數折抵資訊

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 /scmapi/api/StoreDelivery/GetPreparingOrders

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

{
    "OrderCount": 4,
    "Orders": [
        {
            "OrderInfo": {
                "OrderCode": "RM2409040001571",
                "OrderType": "一般賣場",
                "TransferDate": "2024-09-04T15:23:09.373",
                "ExpectedShippingDate": "2024-09-05T23:59:00",
                "LastShippingDate": "2024-09-05T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": null,
                "Status": null
            },
            "ReceiverInfo": {
                "Name": "胡尚淳",
                "Mobile": "0979101111"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "中坡門市",
                "Id": "140210"
            },
            "Products": [
                {
                    "Id": 6497187,
                    "Name": "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567891",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 0,
                    "Subtotal": 0,
                    "ProductPrice": 400
                },
                {
                    "Id": 6804909,
                    "Name": "贈品",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 0,
                    "Subtotal": 0,
                    "ProductPrice": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "OrderCode": "RM2409040001573",
                "OrderType": "一般賣場",
                "TransferDate": "2024-09-04T15:27:05.453",
                "ExpectedShippingDate": "2024-09-05T23:59:00",
                "LastShippingDate": "2024-09-05T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": null,
                "Status": null
            },
            "ReceiverInfo": {
                "Name": "胡尚淳",
                "Mobile": "0979101111"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(全家)",
                "Name": "全家永樂店",
                "Id": "F010875"
            },
            "Products": [
                {
                    "Id": 6497187,
                    "Name": "1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567891",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 0,
                    "Subtotal": 0,
                    "ProductPrice": 400
                },
                {
                    "Id": 6804909,
                    "Name": "贈品",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 0,
                    "Subtotal": 0,
                    "ProductPrice": 0
                }
            ]
        },
        {
            "OrderInfo": {
                "OrderCode": "RM2409040001679",
                "OrderType": "一般賣場",
                "TransferDate": "2024-09-04T15:38:09.597",
                "ExpectedShippingDate": "2024-09-05T23:59:00",
                "LastShippingDate": "2024-09-05T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": null,
                "Status": null
            },
            "ReceiverInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "士東門市",
                "Id": "955348"
            },
            "Products": [
                {
                    "Id": 6448692,
                    "Name": "[BDD賣場-請勿下單] 宅店配20000以上",
                    "Attribute": "",
                    "SupplierNo": "A1234567890",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 100,
                    "Subtotal": 100,
                    "ProductPrice": 15000
                }
            ]
        },
        {
            "OrderInfo": {
                "OrderCode": "RM2409040001678",
                "OrderType": "一般賣場",
                "TransferDate": "2024-09-04T15:38:09.567",
                "ExpectedShippingDate": "2024-09-05T23:59:00",
                "LastShippingDate": "2024-09-05T23:59:00",
                "Note": "",
                "ShippingDate": "0001-01-01T00:00:00",
                "DeliveryDate": null,
                "Status": null
            },
            "ReceiverInfo": {
                "Name": "雅虎零",
                "Mobile": "0955120000"
            },
            "StoreInfo": {
                "Type": "超商付款取貨(7-11)",
                "Name": "士東門市",
                "Id": "955348"
            },
            "Products": [
                {
                    "Id": 6486052,
                    "Name": "測試賣場-請勿修改",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 10,
                    "Subtotal": 10,
                    "ProductPrice": 20
                },
                {
                    "Id": 6486052,
                    "Name": "測試賣場-請勿修改",
                    "Attribute": "",
                    "SupplierNo": "",
                    "Type": "一般商品",
                    "Qty": 1,
                    "Cost": 10,
                    "Subtotal": 10,
                    "ProductPrice": 20
                }
            ]
        }
    ]
}

Response Elements #

若操作成功，API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的待出貨清單。

OrderCount #

資料筆數。
資料型態: Integer

Orders #

顯示待出貨清單的內容。Orders 的結構分別說明如下：

  • OrderInfo：訂單相關資訊
  • ReceiverInfo：收件人相關資訊
  • StoreInfo：超商相關資訊
  • Products：商品相關資訊

資料型態: Object Array

OrderInfo #

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

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

資料型態: Object

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

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