無法出貨

三方作業 #

無法出貨 #

登錄無法出貨。

Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/ThirdPartyDelivery/RegisterToSuspendOrders
HTTP Method: POST

Request Body #

OrderCode #

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

SuspensiveCause #

無法出貨原因代碼。
資料型態: Integer
必填: 是
說明：來自API無法出貨原因查詢

  • “11”: “無法出貨”,
  • “12”: “延遲出貨1~3天內”,
  • “13”: “延遲出貨3天以上”,
  • “21”: “延遲出貨”,
  • “22”: “無交期”,
  • “23”: “其他”,
  • “24”: “客約問題”,
  • “25”: “三方轉直配”

SuspensiveNote #

無法出貨註解。
資料型態: String
必填: 是
說明：描述無法出貨的原因

Request/Response Sample #

POST /scmapi/api/ThirdPartyDelivery/RegisterToSuspendOrders

[
  {
    "OrderCode": "RM2405280000050",
    "SuspensiveCause": 11,
    "SuspensiveNote": "test 無法出貨"
  },
  {
    "OrderCode": "RM2405280000054",
    "SuspensiveCause": 21,
    "SuspensiveNote": "test 延遲出貨"
  },
  {
    "OrderCode": "RM2405280000067",
    "SuspensiveCause": 25,
    "SuspensiveNote": "test 三方轉直配"
  }
]

{
    "ResponseCode": "00000",
    "ResponseMessage": "成功",
    "SuccessOrdersCount": 3,
    "FailOrdersCount": 0,
    "FailOrders": []
}

{
    "ResponseCode": "00001",
    "ResponseMessage": "訂單有錯誤",
    "SuccessOrdersCount": 0,
    "FailOrdersCount": 3,
    "FailOrders": [
        {
            "OrderCode": "RM2405280000050",
            "FailCode": "2172",
            "FailMessage": "已申請無法出貨但尚未結案"
        },
        {
            "OrderCode": "RM2405280000054",
            "FailCode": "2172",
            "FailMessage": "已申請無法出貨但尚未結案"
        },
        {
            "OrderCode": "RM2405280000067",
            "FailCode": "2172",
            "FailMessage": "已申請無法出貨但尚未結案"
        }
    ]
}

Response Elements #

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

ResponseCode #

回覆無法出貨狀態執行代碼。
資料型態: String
說明：

  • 00000：執行成功
  • 00001：執行部份失敗或全失敗

ResponseMessage #

回覆執行狀態訊息。
資料型態: String

SuccessOrdersCount #

執行成功筆數。
資料型態: Integer
說明：顯示執行成功的筆數。

FailOrdersCount #

執行失敗筆數。
資料型態: Integer
說明：顯示執行失敗的筆數。

FailOrders #

顯示失敗的訂單編號、錯誤代碼與錯誤訊息。

  • OrderCode：訂單編號
  • FailCode：錯誤代碼
  • FailMessage：錯誤訊息

資料型態: Object Array

OrderCode #

訂單編號。
資料型態: String
說明：顯示執行失敗的訂單編號。

FailCode #

錯誤代碼。
資料型態: String
說明：

  • “2171”：訂單不存在
  • “2172”：已申請無法出貨但尚未結案
  • “2173”：傳入的無法出貨原因不存在
  • “2174”：此訂單不可執行無法出貨作業
FailMessage #

錯誤訊息。
資料型態: String
說明：顯示執行失敗錯誤的原因。