본문 바로가기
스마일배송 API/외부주문

외부주문 출고요청 API

Description
[POST] https://sa2.esmplus.com/efm/v1/api/service/SetOuterOrderInterface
등록한 외부주문의 출고요청 처리하는 API입니다.
출고요청 성공한 주문의 실제 출고처리 성공여부 및 이후 배송처리 현황은 외부주문 조회 API를 통해 확인 가능합니다.
출고요청 실패한 주문 건은 자동으로 출고취소되므로 별도 출고취소 요청을 하지 않으셔도 됩니다.

API로 등록한 외부주문은 API로 반드시 출고요청처리 부탁드립니다.
EFM에서 진행할 경우 정보 누락되어 출고요청처리 이슈될 수 있습니다.

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 최대 1000개까지만 동시 발송요청 가능합니다. 스마일주문번호 1000개 초과하여 요청하는 경우
FailReasons > Message 유효하지 않은 스마일주문번호입니다. 스마일주문번호로 조회되는 주문이 없는 경우
FailReasons > Message 판매자의 주문번호가 아닙니다. 인증 셀러의 주문이 아닌 경우
FailReasons > Message 이미 취소한 주문입니다. 주문 상태가 출고취소인 경우
FailReasons > Message 이미 출고요청한 주문입니다. 출고요청 상태거나, 출고실패한 주문일 경우
FailReasons > Message 존재하지 않는 SKU번호입니다. 기등록한 SKU 정보가 유효하지 않은 경우
FailReasons > Message 판매자의 SKU번호가 아닙니다. 기등록한 SKU가 인증 셀러의 SKU가 아닌 경우
FailReasons > Message %SKU번호% SKU 상태가 출고 가능한 상태가 아닙니다. 출고정지 혹은 품절 상태일 수 있습니다. SKU를 확인해주세요. 기등록한 SKU가 '정상' 혹은 '입고대기' 상태가 아닌 경우

 

'스마일배송 API > 외부주문' 카테고리의 다른 글

외부주문 등록수정 API  (0) 2022.11.03
외부주문 조회 API  (0) 2022.11.03
외부주문 출고취소 API  (0) 2022.11.03
외부주문 삭제 API  (0) 2022.11.03
반품/교환입고 등록 API  (0) 2022.11.03