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

외부주문 등록수정 API

Description
[POST] https://sa2.esmplus.com/efm/v1/api/service/SetOuterOrder
외부주문을 등록 or 수정합니다.
이미 출고준비 단계로 넘어간 주문에 대해서는 배송지 수정 등 주문 정보 수정이 불가하니 참고 부탁드립니다.
API로 등록한 외부주문은 API로 반드시 출고요청처리 부탁드립니다. EFM에서 진행할 경우 정보 누락되어 출고요청처리 이슈될 수 있습니다.

Request Description

항목 항목명 필수여부 Type Description
SmileOrderNo 스마일주문번호   Int 외부주문정보 수정할 경우 필수값
SiteId 사이트코드 Y Int 아래 url 내 사이트 코드 참조
https://etapi.gmarket.com/97
OuterCartNo 외부장바구니번호 Y Int 외부채널의 장바구니번호
SiteUserInput 사이트직접입력   string 사이트코드 23(기타/직접입력)일 경우 필수값
OuterOrderNo 외부주문번호 Y string 외부채널의 주문번호
OuterGoodsNo 외부상품번호 Y String 외부채널의 상품번호
DeliveryWishDate 고객배송희망일자   Date-Time 외부채널에서 고객이 배송희망일자 선택했을 경우 연동
GoodsName 외부채널 상품명 Y String 외부채널의 상품명
OrderQty 외부주문수량 Y Int 외부채널의 주문수량
해당 주문의 SKU별 출고수량을 계산 가능할 경우 해당 값은 "1"로 고정

주의!! "출고수량 = 외부주문수량(OrderQty) X SKU총출고수량(OwQty) "

각 SKU별로 해당 계산식으로 계산되어 출고요청됨(아래 'Sample Code_출고수량계산' 참고)
OptValue 외부주문옵션명 Y string 외부채널의 주문옵션명
AdultYn 청소년구매불가 성인상품여부 Y string 성인상품인지 여부 입력
Y: 청소년구매불가성인상품
N: 성인상품 아님
BundleType 합포장여부 Y string B:합포장가능
I:합포장불가능
RcverInfoNa 수령인명 Y string 외부채널의 배송수령인명 입력
최대 50byte까지 입력
RcverInfoCp 수령인휴대폰번호 Y string 하이픈 포함하여 입력
"3자리/4자리 - 3자리/4자리 - 4자리" 로 자릿수 체크
RcverInfoHt 수령인일반전화번호   string 하이픈 포함하여 입력
"2자리/3자리 - 3자리/4자리 - 4자리" 로 자릿수 체크
ZipCode 수령인우편번호 Y string 5자리인 경우, 하이픈 없이 숫자만 입력
6자라인 경우, 하이픈 포함하여 입력
RcverInfoAd1 수령인기본주소 Y string 66byte까지 입력
우편번호 입력 시, 자동생성되는 Address1 입력
RcverInfoAd2 수령인상세주소 Y string 66byte까지 입력
고객 직접입력한 상세주소 입력
아래 특수기호 및 키보드 + 한자 기호는 입력 불가
! $ % ^ * \ [ ] " = ; ? < > ` { } |
※ 빈값 입력 가능, 단 null 은 불가함
Memo 수령인배송메모 Y string 외부사이트에서 고객이 입력한 배송기재사항 입력
DeliveryDueDate 외부주문배송기한일자 Y Date YYYY-MM-DD
외부사이트에서 판매자에게 요구하는 배송기한일자 입력(판매자 패널티대상되는 일자)
G마켓/옥션의 '발송마감일' 기능과 동일한 일자
DeliveryDueTime 외부주문배송기한일시 Y TimeSpan hh:mm:ss형식
외부사이트에서 판매자에게 요구하는 배송기한시간 입력(판매자 패널티대상되는 시간)
G마켓/옥션의 '발송마감일' 기능과 동일한 일자
InvoiceGoodsName 송장출력용상품명   string (추후제공예정)송장출력용 상품명을 판매자가 등록하면 해당 상품명으로 송장출력됨
성인용품 등 상품명 변경하여 출고되어야 하는 상품에 사용
Goods_Name에 등록된 상품명은 송장출력되지 않음
SkuDetail > skuId []SKU번호 Y Int 지마켓에서 채번한 SKU번호 입력
최대 30개까지만 SKU병렬정보를 입력 가능
SKU 조합 내 동일한 SKU번호 입력불가
SkuDetail > OwQty []SKU총출고수량 Y Int 해당 SKU의 출고 수량을 카운팅하여 연동
정수만 입력 가능
0입력불가
JSON
{
  "SmileOrderNo": 0,
  "SiteId": 0,
  "OuterCartNo": 0,
  "OuterOrderNo": "string",
  "OuterGoodsNo": "string",
  "GoodsName": "string",
  "OrderQty": 0,
  "OptValue": "string",
  "BundleType": "string",
  "DeliveryWishDate": "2020-01-17T03:51:35.890Z",
  "RcverInfoNa": "string",
  "RcverInfoHt": "string",
  "RcverInfoCp": "string",
  "RcverInfoAd1": "string",
  "RcverInfoAd2": "string",
  "ZipCode": "string",
  "Memo": "string",
  "DeliveryDueDate": "2020-01-23",
  "DeliveryDueTime": "00:00:00",
  "SiteUserInput": "string",
  "AdultYn": "string",
  "InvoiceGoodsName": "string"
  "SkuDetail": [
    {
      "SkuId": 0,
      "OwQty": 0
    }
  ]
}

출고수량계산
- 각 SKU의 출고수량은 "외부주문수량(OrderQty) X SKU총출고수량(OwQty)"로 계산됨
- 예) 아래의 케이스 외부주문번호를 출고요청 시, 41741번 SKU는 2X120=240개 , 41742번 SKU는 2X10=20개로 출고요청됨

 

Response Description

항목 항목명 Type Description
ResultCode 결과코드 int 성공: 0
실패 :Error Massage 참고
Message 메시지 string  
Data Data string  
Data > SmileOrderNo 스마일주문번호 string 처리된 스마일주문번호 Return

 JSON_Success

{
  "ResultCode": 0,
  "Message": "string",
  "Data": {
    "SmileOrderNo": 0
  }
}

Sample Code_Success

{
    "ResultCode": 0,
    "Message": "success",
    "Data": {
        "SmileOrderNo": 408813
    }
}

Error Code

결과코드 메시지 원인
1400 {Entity명}은 숫자만 입력 가능합니다. 숫자만 입력해야 하는 필드에 숫자이외값 입력 시
1400 유효하지 않은 스마일주문번호입니다.
SmileOrderNo > 유효하지 않은 항목값 입력했을 경우
1400 주문번호은/는 50Byte까지만 입력 가능합니다. {입력값} {길이} OuterOrderNo > 외부주문번호 50Byte이상 넣었을 경우 (한글 3Byte 기준)
1400 상품번호은/는 50Byte까지만 입력 가능합니다. {입력값} {길이} OuterGoodsNo > 외부상품번호 50Byte이상 넣었을 경우 (한글 3Byte 기준)
1400 사이트 코드가 유효하지 않습니다.{입력값} SiteId > 유효하지 않은 항목값 입력했을 경우
1400 사이트 코드가 기타(23)일 경우, 사이트직접입력값은 필수입니다. SiteId, SiteUserInput > 사이트 코드가 23인데 사이트직접입력 미입력 시
1400 장바구니 번호가 유효하지 않습니다.{입력값} OuterCartNo > 유효하지 않은 항목값 입력했을 경우
1400 상품번호는 필수입력 항목입니다. OuterGoodsNo > 미입력 시
1400 상품명은 필수입력 항목입니다. GoodsName > 미입력 시
1400 상품명은/는 100Byte까지만 입력 가능합니다. {입력값} GoodsName > 상품명 100Byte이상 넣었을 경우(한글기준)
1400 상품수량이 유효하지 않습니다. {입력값} OrderQty > 0 또는 음수 입력 시
1400 성인상품여부는 성인상품(Y), 비성인상품(N)만 입력 가능합니다. AdultYn > 성인상품여부 잘못 넣었을 경우
1400 합포장은 가능(B), 불가능(I)만 입력 가능합니다. BundleType > 유효하지 않은 항목값 입력 시
1400 수령인 이름은/는 50Byte까지만 입력 가능합니다. : {입력수령인명} RcverInfoNa > 수령인명 Byte수 초과했을 경우
1400 휴대폰은 필수입력 항목입니다. RvverInfoCp > 미입력 시
1400 휴대폰은 '-'로 구분해서 넣어주세요. RcverInfoCp > 하이픈 제거하여 넣었을 경우
1400 정확한 휴대폰 정보를 입력해 주세요 RcverInfoCp > 휴대폰 형식에 맞지 않을 경우
1400 전화번호는 '-'로 구분해서 넣어주세요. RcverInfoHt > 하이픈 제거하여 넣었을 경우
1400 배송지 우편번호는 필수입력 항목입니다. ZipCode > 미입력 시
1400 우편번호 형식이 올바르지 않습니다. ZipCode > 유효하지 않은 우편번호 넣었을 경우
1400 6자리 우편번호는 '-'로 구분해서 넣어주세요. ZipCode > 6자리 우편번호에서 하이픈 제거하거나 6자리 이상 우편번호 넣었을 경우
1400 배송지 기본주소는 필수입력 항목입니다. RcverInfoAd1 > 미입력 시
1400 기본주소는 100자까지 입력 가능합니다.(공백제외) RcverInfoAd1 > 허용된 범위 넘었을 경우
1400 기본주소에 특수문자는 사용할 수 없습니다. RcverInfoAd1 > 허용하지 않는 특수문자가 포함된 경우
1400 배송지 상세주소는 필수입력 항목입니다. RcverInfoAd2 > 미입력 시
1400 상세주소는 100자까지 입력 가능합니다.(공백제외) RcverInfoAd2 > 허용된 범위 넘었을 경우
1400 상세주소에 특수문자는 사용할 수 없습니다. RcverInfoAd2 > 허용하지 않는 특수문자가 포함된 경우
1400 주문배송기한시간을 입력할 경우 주문배송기한일자는 필수입니다. DeliveryDueDate > 미입력 시
1400 주문배송기한일자를 입력할 경우 주문배송기한시간은 필수입니다. DeliveryDueTime > 미입력 시
1400 송장상품명은/는 100Byte까지만 입력 가능합니다. {입력값} InvoiceGoodsName > 송장상품명 100Byte이상 넣었을 경우
1400 SKU조합은 최대 30개까지만 입력 가능합니다. SkuDetail > SkuId > SKU 조합 30개 초과 입력 시
1400 동일한 SKU번호가 중복으로 입력되었습니다. SkuDetail > SkuId > 중복된 SKU를 동시 등록 시
1400 존재하지 않는 SKU번호입니다. {입력값} SkuDetail > SkuId > 미입력 시
1400 판매자의 SKU번호가 아닙니다. SkuDetail > SkuId > 해당판매자의 SKU번호가 아닐 경우
1400 판매 가능한 상태의 SKU가 아닙니다. : SKU번호[입력값] SkuDetail > SkuId > 정상 외 SKU 넣을 경우
1400 SKU의 판매 가능한 재고가 없습니다 SkuDetail > SkuId > SKU의 판매가능재고가 0일 경우
1400 SKU출고수량이 유효하지 않습니다. : SKU번호[{입력값}] 출고수량[{입력값}] SkuDetail > OwQty > 0 또는 음수 입력 시
1400 묶음배송(합포장)이 가능한 SKU와 불가능한 SKU는 동시에 등록하실 수 없습니다. SkuDetail > SkuId > 합포장 가능한 SKU와 불가능한 SKU가 혼재해있는 경우
1400 출고준비 단계로 수정 가능한 상태가 아닙니다. 수정 불가능한 상태로 넘어간 주문건을 수정요청할 경우
1400 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