배송

운송장 트래킹 정보 수신(BO)

post

기능설명

외부 배송추적시스템 운송장 정보를 수신 받습니다.

상세설명

외부 배송추적 시스템 정보를 수신받고, 배송완료인 경우 주문내역상태를 배송완료로 변경합니다.
스윗트래커(외부시스템)와 연동하는 컨트롤러입니다.
스윗트래커와 연동하는 식별값은 배송번호입니다.
요청/응답은 json 형식으로 처리합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

stringOptional

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/delivery/tracker/trackerCallback

POST /api/order/v1/delivery/tracker/trackerCallback HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

text

배송지역그룹번호 조회

post

기능 설명

배송지의 도서산간 여부를 조회합니다.

상세 설명

배송지의 우편번호를 사용하여 배송지역그룹번호를 조회합니다.
추가배송비가 있는 경우, 배송지역그룹번호를 리턴합니다.

수정번호

Release v2.00_240711: 배송 지역그룹 별 추가 배송비 적용

Header parameters

AuthorizationanyOptional

Access Token

Body

도서 산간 여부 조회 Request DTO

zipNostringOptional

우편번호

Example: 05836

deliPolcNostringOptional

배송정책번호

Example: 10000431

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/delivery/deliveryRegion/getDeliRegnGrpNo

POST /api/order/v1/delivery/deliveryRegion/getDeliRegnGrpNo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "zipNo": "05836",
  "deliPolcNo": "10000431"
}

text

배송지 변경 가능 여부 조회

post

기능 설명

배송지 변경 가능 여부를 조회합니다.

상세 설명

우편번호와 배송정책번호를 사용하여 추가배송비를 조회합니다.
추가배송비 금액이 동일한 배송지역그룹으로 배송지 변경이 가능합니다.

수정번호

Release v2.00_240711: 추가배송비 금액이 동일한 배송지역그룹으로 배송지 변경 가능하도록 수정

Header parameters

AuthorizationanyOptional

Access Token

Body

주문 배송지 변경/등록 DTO

ordNostringRequired

주문번호

Example: 20230809O007943

clmNostringOptional

클레임번호

Example: 20230801C008072

systemTypestring · enumOptional

SYSTEM(시스템유형) * 10 : FO * 20 : BO

Example: 10Possible values:

mbrNostringOptional

회원번호

Example: 10000001

deliNostringRequired

배송번호

Example: 100008491

deliPolcNostringRequired

배송정책번호

Example: 10000431

dlvpNmstringRequired

배송지명

Example: 집

rcvmnNmstringRequired

수취인명

Example: 홍길동

zipNoSeqinteger · int32Optional

우편번호순번

Example: 1

zipNostringRequired

변경후우편번호

Example: 08739

originZipNostringOptional

변경전우편번호

Example: 05837

orginDlvpSeqstringOptional

변경전배송지순번

Example: 1

zipAddrstringRequired

우편주소

Example: 서울 송파구 법원로9길

dtlAddrstringOptional

상세주소

Example: 에이치비지니스파크 D동 6층23

rcvmnCellSctNostringRequired

수취인휴대폰구분번호

Example: 010

rcvmnCellTxnoNostringRequired

수취인휴대폰국번번호

Example: 1234

rcvmnCellEndNostringRequired

수취인휴대폰끝번호

Example: 5678

deliMsgstringOptional

배송메시지

Example: 문 앞에 두고 가주세요.

deliMsgCdstringOptional

배송메시지코드(ME039) 10:배송메시지 입력 안함, 20:배송 전 연락 바랍니다, 30:부재 시 문 앞에 놓아주세요, 40: 부재 시 경비실에 맡겨주세요, 50: 빠른 배송 부탁 드립니다, 60: 부재 시 핸드폰으로 연락 바랍니다, 70: 직접입력

Example: 10

comnFrdrEtcMethodstringOptional

공동현관기타방법

Example: 자유출입가능

comnFrdrPwdstringOptional

공동현관비밀번호

Example: 1234

comnFrdrCogoMethodCdstringOptional

공동현관출입방법코드(ME040) 10: 공동현관 출입번호, 20: 자유 출입 가능, 30: 기타

Example: 10

deliGbCdstring · enumOptional

LO001(배송구분코드) * 10 : 출하 * 20 : 회수

Example: 10Possible values:

dlvpSeqstringOptional

배송순번

Example: 1

rcvmnEmailAddrstringOptional

수취인이메일

Example: test@plateer.com

rcvmnTelRgnNostringOptional

수취인전화지역번호

Example: 02

rcvmnTelTxnoNostringOptional

수취인전화국번번호

Example: 1234

rcvmnTelEndNostringOptional

수취인전화끝번호

Example: 5678

frgnDirPurGoodsYnstringOptional

해외직구상품여부

Responses

200

성공

*/*

booleanOptional

900

업무처리 오류 내용

*/*

post/v1/delivery/deliveryRegion/deliveryRegionCheck

POST /api/order/v1/delivery/deliveryRegion/deliveryRegionCheck HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 721

{
  "ordNo": "20230809O007943",
  "clmNo": "20230801C008072",
  "systemType": "10",
  "mbrNo": "10000001",
  "deliNo": "100008491",
  "deliPolcNo": "10000431",
  "dlvpNm": "집",
  "rcvmnNm": "홍길동",
  "zipNoSeq": 1,
  "zipNo": "08739",
  "originZipNo": "05837",
  "orginDlvpSeq": "1",
  "zipAddr": "서울 송파구 법원로9길",
  "dtlAddr": "에이치비지니스파크 D동 6층23",
  "rcvmnCellSctNo": "010",
  "rcvmnCellTxnoNo": "1234",
  "rcvmnCellEndNo": "5678",
  "deliMsg": "문 앞에 두고 가주세요.",
  "deliMsgCd": "10",
  "comnFrdrEtcMethod": "자유출입가능",
  "comnFrdrPwd": "1234",
  "comnFrdrCogoMethodCd": "10",
  "deliGbCd": "10",
  "dlvpSeq": "1",
  "rcvmnEmailAddr": "test@plateer.com",
  "rcvmnTelRgnNo": "02",
  "rcvmnTelTxnoNo": "1234",
  "rcvmnTelEndNo": "5678",
  "frgnDirPurGoodsYn": "text"
}

true

결품처리(BO)

post

기능설명

[BO] 결품처리를 진행합니다.

상세설명

원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 결품처리 요청목록(insuffDeliveryProcessInfoList)은 필수로 있어야합니다.
원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)
- 결품등록 : 22(출고지시) -> 23(출고대기)
- 결품해제 : 23(출고대기) -> 22(출고지시)
결품등록, 결품해제 처리를 진행합니다.
원주문내역상태코드와 처리할 주문내역상태코드를 요청값으로 받아서 원주문내역상태코드리스트를 조회하여 검증 후 처리할 주문내역상태코드로 업데이트를 진행합니다.
결품등록 후 주문자에게 배송지연 알림(알림톡, 알림함)이 발송됩니다.
결품등록 후 고객센터 OB목록에 자동으로 등록됩니다.

수정번호

Release v1.01_251030: 결품등록 및 결품해제 시 요청된 목록 중 상태변경 validation 체크추가

Header parameters

AuthorizationanyOptional

Access Token

Body

결품처리 요청정보

ordDtlStatCdstring · enumRequired

OM005(주문내역상태코드) 10: REPAY_REQ(재결제요청) ,11: ORDER_ACCEPT(주문접수) ,12: ORDER_COMPLETE(주문완료) ,13: ORDER_CANCEL(주문취소) ,21: DELIVERY_ORDER(배송지시) ,22: SHIPPING_ORDER(출고지시) ,23: SHIPPING_WAIT(출고대기) ,25: SHIPPING_CONFIRM(출고확정) ,26: SHIPPING_FINISH(출고완료) ,27: DELIVERY_FINISH(배송완료) ,31: RETURN_APPLY(결제대기) ,32: RETURN_ACCEPT(반품접수) ,33: RETURN_CANCEL(반품취소) ,34: WITHDRAWAL_ORDER(회수지시) ,35: WITHDRAWAL_CONFIRM(회수확인) ,36: WITHDRAWAL_FINISH(회수완료) ,37: RETURN_FINISH(반품완료)

Example: 10Possible values:

targetOrdDtlStatCdstring · enumRequired

Example: 10Possible values:

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/delivery/deliveryProcess/processInsuffDelivery

POST /api/order/v1/delivery/deliveryProcess/processInsuffDelivery HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "ordDtlStatCd": "10",
  "targetOrdDtlStatCd": "10",
  "insuffDeliveryProcessInfoList": [
    {
      "ordNo": "20230809O000001",
      "deliNo": "100000001",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "shipWaitCaus": "10",
      "shipWaitCausCont": "수급물량부족",
      "insuffQty": 1
    }
  ]
}

No content

배송처리(BO)

post

기능설명

[BO] 배송처리를 진행합니다.

상세설명

원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 배송처리 목록(deliveryProcessInfoList)은 필수로 있어야합니다.
원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)
- 배송지시 : 12(주문완료) -> 21(배송지시)
- 출고지시 : 21(배송지시) -> 22(출고지시)
- 출고완료 : 22(출고지시) -> 26(출고완료)
- 배송완료 : 26(출고완료) -> 27(배송완료)
배송지시, 출고지시, 출고완료, 배송완료를 진행합니다.
원주문내역상태코드와 처리할 주문내역상태코드를 요청값으로 받아서 원주문내역상태코드리스트를 조회하여 검증 후 처리할 주문내역상태코드로 업데이트를 진행합니다.
출고완료 후 주문자에게 알림(알림톡, 알림함)이 발송됩니다.
교환주문 출고완료시 이메일 알림이 발송됩니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

배송처리 요청 DTO

ordDtlStatCdstring · enumRequired

Example: 10Possible values:

targetOrdDtlStatCdstring · enumRequired

Example: 10Possible values:

deliDtlStatCdstring · enumOptional

LO016(배송내역상태코드) 10: DELIVERY_ORDER (배송지시) 11: SHIPPING_ORDER (출고지시) 12: SHIPPING_WAIT (출고대기) 13: SHIPPING_CONFIRM (출고확정) 14: SHIPPING_FINISH (출고완료) 15: DELIVERY_FINISH (배송완료) 20: WITHDRAWAL_ORDER (회수지시) 21: WITHDRAWAL_CONFIRM (회수확인) 22: WITHDRAWAL_FINISH (회수완료)

Example: 10Possible values:

targetDeliDtlStatCdstring · enumOptional

Example: 10Possible values:

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/delivery/deliveryProcess/processDelivery

POST /api/order/v1/delivery/deliveryProcess/processDelivery HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "ordDtlStatCd": "10",
  "targetOrdDtlStatCd": "10",
  "deliDtlStatCd": "10",
  "targetDeliDtlStatCd": "10",
  "deliveryProcessInfoList": [
    {
      "ordNo": "20230809O000001",
      "ordSeq": 1,
      "shipQty": 1,
      "deliSeq": 1,
      "deliNo": "100000001",
      "hdcCd": "10",
      "invNo": "123456789123",
      "alimYn": "Y"
    }
  ]
}

No content

수령완료처리(FO)

post

기능설명

[FO] 주문 배송 완료 처리합니다.

상세설명

단건의 주문을 배송완료 처리합니다.
원주문의 주문내역상태코드와 변경할 상태코드(배송완료 : 27)를 넘겨, 배송완료 상태로 업데이트합니다.

Header parameters

AuthorizationanyOptional

Access Token

Body

FO 수령완료 처리 요청 DTO

ordDtlStatCdstringRequired

원주문내역상태코드

Example: 22

targetOrdDtlStatCdstringRequired

변경상태

Example: 26

targetDeliDtlStatCdstring · enumRequired

Example: 10Possible values:

systemTypestringOptional

시스템구분코드

Example: 10

ordNostringOptional

주문번호

Example: 20230809O000001

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/delivery/deliveryProcess/processDeliveryFO

POST /api/order/v1/delivery/deliveryProcess/processDeliveryFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "ordDtlStatCd": "22",
  "targetOrdDtlStatCd": "26",
  "targetDeliDtlStatCd": "10",
  "systemType": "10",
  "ordNo": "20230809O000001",
  "deliveryProcessInfoList": [
    {
      "ordNo": "20230809O000001",
      "ordSeq": 1,
      "shipQty": 1,
      "deliSeq": 1,
      "deliNo": "100000001",
      "hdcCd": "10",
      "invNo": "123456789123",
      "alimYn": "Y"
    }
  ]
}

No content

배송완료 지시 배치(BATCH)

post

기능설명

배송완료 지시 대량 데이터 일괄 처리를 진행합니다.

상세설명

배치서비스에서 요청받은 출고완료 주문을 배송완료 처리합니다.
주문내역상태(OM005)가 출고완료(26)인 주문을 배송완료(27) 처리합니다.
출고완료 후 특정 기일(ST004:자동배송완료처리 REF_1_VAL 값)이 경과한 주문에 대해 처리합니다.
주문번호, 배송번호, 배송완료 대상 목록은 필수 값입니다.
목록은 1000건씩 분할해서 처리합니다.

Header parameters

AuthorizationanyOptional

Access Token

Bodyobject · DeliveryFinishInstructionInfo[]

ordNostringOptional

ordSeqinteger · int32Optional

ordProcSeqinteger · int32Optional

deliNostringOptional

deliSeqinteger · int32Optional

invNostringOptional

ordDtlStatCdstringOptional

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/delivery/batchProcess/deliveryFinishInstructionProcess

POST /api/order/v1/delivery/batchProcess/deliveryFinishInstructionProcess HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 109

[
  {
    "ordNo": "text",
    "ordSeq": 1,
    "ordProcSeq": 1,
    "deliNo": "text",
    "deliSeq": 1,
    "invNo": "text",
    "ordDtlStatCd": "text"
  }
]

No content

단건 배송 트래킹

get

기능설명

배송 상태를 조회합니다.

상세설명

배송번호(단건)를 이용해 현재 배송상태를 조회합니다.
스윗트래커(외부시스템)와 연동하여 조회합니다.
응답값으로 완료여부, 택배사명, 운송장번호, 배송상세정보(배송진행시간, 진행위치, 진행상태)를 전달합니다.
스윗트래커와 연동하는 식별값은 배송번호입니다.

수정번호

Release v2.00_240401: 이벤트 배송상품 스위트래커 조회 개발
Release v2.00_250618: fid 사용하여 hdc 조회하는 로직 변경 (분리출고 DB 변경 대응)

Query parameters

fidstringRequired

string

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

application/json

배송 조회 응답 DTO

completeYnstringOptional

배송완료여부

Example: Y

hdcNmstringOptional

택배사명

Example: CJ대한통운

invoiceNostringOptional

송장번호

Example: 1122410479

900

업무처리 오류 내용

application/json

get/v1/delivery/tracker/deliveryTracking/{fid}

GET /api/order/v1/delivery/tracker/deliveryTracking/{fid}?fid=text HTTP/1.1
Host: api-order.x2bee.com/
Accept: */*

{
  "completeYn": "Y",
  "hdcNm": "CJ대한통운",
  "invoiceNo": "1122410479",
  "detailsList": [
    {
      "time": "2019-12-25 09:46:53",
      "where": "화성비봉발송",
      "kind": "화성비봉발송"
    }
  ]
}

이전회수

다음주문클레임 대시보드

마지막 업데이트 4개월 전