直配作業 #

退貨單確認 #

進行直配訂單的退貨單確認。

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

Request Body #

ReturnCodes #

退貨單號。
資料型態: String Array
必填: 是

Request/Response Sample #

POST Request

POST /scmapi/api/HomeDelivery/ConfirmReturnOrders

{
  "ReturnCodes": [
    "2024061700016R",
    "2024061700007R",
    "2024061700008R"
  ]
}

POST Response（成功案例）

{
  "ResponseMessage": "成功",
  "SuccessfulCount": 1,
  "FailedCount": 0,
  "SuccessfulReturnGoods": [
    {
      "ReturnCode": "2024061700599R",
      "ReturnSerialNumber": 27622932,
      "FailMessage": ""
    }
  ],
  "FailedReturnGoods": []
}

POST Response（失敗案例）

{
  "ResponseMessage": "成功",
  "SuccessfulCount": 0,
  "FailedCount": 3,
  "SuccessfulReturnGoods": [],
  "FailedReturnGoods": [
    {
      "ReturnCode": "2024061700007R",
      "ReturnSerialNumber": 1967266,
      "FailMessage": "退貨結案失敗"
    },
    {
      "ReturnCode": "2024061700008R",
      "ReturnSerialNumber": 1967267,
      "FailMessage": "退貨結案失敗"
    },
    {
      "ReturnCode": "2024061700016R",
      "ReturnSerialNumber": 1967275,
      "FailMessage": "退貨結案失敗"
    }
  ]
}

Response Elements #

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

ResponseMessage #

回覆API執行成功與否訊息。
資料型態: String
說明：僅顯示API執行狀況, 若有失敗的狀況則在下方顯示FailedReturnGoods顯示

SuccessfulCount #

執行退貨確認成功的筆數。
資料型態: Integer

FailedCount #

執行退貨確認失敗的筆數。
資料型態: Integer

SuccessfulReturnGoods #

執行退貨確認成功的退貨單細節

ReturnCode：退貨單編號
ReturnSerialNumber：退貨單序號
FailMessage：錯誤訊息

資料型態: Array

ReturnCode #

退貨單編號。
資料型態: String

ReturnSerialNumber #

退貨單序號。
資料型態: Integer

FailMessage #

錯誤訊息。
資料型態: String

FailedReturnGoods #

執行退貨確認失敗的退貨單細節

ReturnCode：退貨單編號
ReturnSerialNumber：退貨單序號
FailMessage：錯誤訊息