외부주문 출고취소 API

Description

[POST] https://sa2.esmplus.com/efm/v1/api/service/CancelOuterOrderInterface

등록한 외부주문의 출고취소처리하는 API입니다. 출고취소는 물류센터에서 할당되기 전 상태만 가능하며 출고 준비단계로 넘어간 주문에 대해서는 출고취소 요청 시 실패처리됩니다.

Request Description

항목	항목명	필수여부	Type	Description
SmileOrderNo	[]스마일주문번호		long	출고처리할 스마일주문번호 입력

JSON
[
  0
]

 

Response Description

항목	항목명	Type	Description
ResultCode	결과코드	int	성공: 0 실패 :Error Massage 참고
Message	메시지	string
Data > RequestCount	요청건수	Int	판매자가 출고요청한 전체 건수
Data > SuccessCount	성공건수	Int	출고요청 성공한 건수 실제 출고처리 성공여부 및 이후 배송처리 현황은 외부주문 조회 API를 통해 확인 가능
Data > SuccessNos	[]성공한스마일주문번호	Int	출고요청 성공한 주문번호 리스트
Data > FailCount	실패건수	Int	출고요청 실패한 건수 출고요청 실패할 경우 자동으로 출고취소 되므로, 별도로 출고취소 API를 호출하지 않아도 됨
Data > FailReasons > FailNos	[]실패한스마일주문번호	Int	출고요청 실패한 주문번호 리스트
Data > FailReasons > Message	[]실패사유	string	출고요청 실패한 주문번호의 실패사유 Error Code 참고

JSON_Success

{
  "ResultCode": 0,
  "Message": "string",
  "Data": {
    "RequestCount": 0,
    "SuccessNos": [
      0
    ],
    "SuccessCount": 0,
    "FailReasons": [
      {
        "SmileOrderNo": 0,
        "Message": "string"
      }
    ],
    "FailCount": 0
  }
}

Sample Code_Success

{
    "ResultCode": 0,
    "Message": "success",
    "Data": {
        "RequestCount": 1,
        "SuccessNos": [
            408905
        ],
        "SuccessCount": 1,
        "FailReasons": [],
        "FailCount": 0
    }
}

Sample Code_Fail

{
    "ResultCode": 0,
    "Message": "success",
    "Data": {
        "RequestCount": 1,
        "SuccessNos": [],
        "SuccessCount": 0,
        "FailReasons": [
            {
                "SmileOrderNo": 408715,
                "Message": "이미 출고요청한 주문입니다."
            }
        ],
        "FailCount": 1
    }
}

Error Code

결과코드	메시지	원인
FailReasons > Message	유효하지 않은 주문번호입니다.	스마일주문번호가 유효하지 않은 경우
FailReasons > Message	판매자의 주문번호가 아닙니다.	스마일주문번호가 다른 판매자의 주문일 경우
FailReasons > Message	이미 출고가 진행되었거나 실패한 출고는 취소가 불가능합니다.	취소 불가한 상태일 경우
FailReasons > Message	취소할 출고가 없습니다. 발송요청하지 않은 외부주문은 삭제만 가능합니다.	출고요청하지 않은 주문일 경우
FailReasons > Message	취소할 출고가 없습니다. 발송요청 실패한 주문입니다.	취소요청 시 실패한 주문번호를 다시 출고취소 요청할 경우
FailReasons > Message	출고 취소처리중 오류 : {스마일주문번호}:존재하지 않는 오더입니다.	출고처리 직후 1분 이내 취소요청을 할 경우 출고처리 이후에는 약 1분 후 취소요청 할 것을 권장