出貨確認

直配作業 #

出貨確認 #

進行直配訂單的出貨確認

Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/HomeDelivery/ConfirmOrders
HTTP Method: POST

Request Body #

ConfirmOrders #

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

  • OrderCode:訂單編號
  • ShipperId:貨運商編號
  • ShipCode:出貨單號

資料型態: Array

OrderCode #

訂單編號。
資料型態: String
必填: 是

ShipperId #

貨運商編號。
資料型態: Integer
必填: 是
說明:來自API出貨物流商查詢

  • 4:新竹
  • 7:郵局
  • 9:宅配通
  • 11:統一宅急便
  • 12:大榮
  • 18:便利帶
  • 19:通盈
  • 21:全球快遞
  • 99:自行運送
ShipCode #

出貨單號。
資料型態: String
必填: 是
說明:出貨單號需符合各貨運商產生規格

Request/Response Sample #

POST /scmapi/api/HomeDelivery/ConfirmOrders

{
	"ConfirmOrders": [{
		"OrderCode": "RM2404240000258",
		"ShipperId": 11,
		"ShipCode": "801417283631"
	}, {
		"OrderCode": "RM2404240000267",
		"ShipperId": 11,
		"ShipCode": "801405331625"
	}]
}
{
    "ResponseCode": "00000",
    "ResponseMessage": "成功",
    "ConfirmOrders": []
}
{
    "ResponseCode": "99999",
    "ResponseMessage": "失敗",
    "ConfirmOrders": [
        {
            "OrderCode": "RM2404240001422",
            "ProcessCode": "2104",
            "ProcessMessage": "訂單已出貨"
        },
        {
            "OrderCode": "RM2404240001421",
            "ProcessCode": "2111",
            "ProcessMessage": "貨運單號有誤"
        }
    ]
}

Response Elements #

若操作成功,API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的出貨狀態包含失敗的顯示訊息。

ResponseCode #

回覆出貨狀態代碼。
資料型態: String
說明:

ResponseMessage #

回覆出貨狀態成功與否訊息。
資料型態: String
說明:對應ResponseCode

  • 成功
  • 訂單有錯誤
  • 失敗

ConfirmOrders #

顯示各訂單的出貨狀況,若ResponseCode = 00000 則顯示空陣列

  • OrderCode:訂單編號
  • ProcessCode:處理代碼
  • ProcessMessage:處理訊息

資料型態: Array

OrderCode #

訂單編號。
資料型態: String

ProcessCode #

處理代碼。
資料型態: String
說明:請見ProcessCode對應表

ProcessMessage #

處理訊息。
資料型態: String
說明:請見ProcessCode對應表

ProcessCode對應表 #
ProcessCode ProcessMessage
2102 訂單非未出貨狀態
2103 非宅配訂單
2104 訂單已出貨
2105 訂單號碼不存在
2106 該訂單已取消
2107 訂單有未結案異動單
2109 無資料或尚未轉單到SCM
2110 物流商代碼不存在
2111 貨運單號有誤
2911 其他錯誤
0000 成功