배송조회

주문상품내역조회

get

기능설명

• 배송상세 화면 내 주문상품내역 목록을 조회합니다.

---

상세설명

• 선택된 주문번호, 배송번호의 상세주문상품내역을 조회합니다.

• 주문수량이 유효한 주문만 조회합니다.(주문수량 - 취소수량 > 0)

• 주문내역상태(OM005)가 주문취소(13), 반품취소(33), 반품완료(37)인 건은 조회하지 않습니다.

• 유입경로가 PO인 경우에는 해당 협력사 데이터만 조회합니다.

---

수정번호

• Release v2.00_240829 : 기본주소 마스킹 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ordNoStringRequired

주문번호

deliNoStringRequired

배송번호

Responses

200

배송상세 주문상품내역 조회 성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryInquiry/getDeliveryOrderDetailList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryInquiry/getDeliveryOrderDetailList?deliveryInquiryRequest=[object+Object]&ordNo=null&deliNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230816O009106",
      "ordSeq": 1,
      "deliNo": 100016628,
      "ordAccpDtm": "2023-12-31 00:00:00",
      "ordGbCd": 10,
      "deliSeq": 1,
      "ordDtlStatCd": 22,
      "deliDtlStatCd": 12,
      "ordDtlGbCd": 10,
      "deliTypCd": 10,
      "deliKindCd": 10,
      "deliProcTypCd": 10,
      "deliProcTypCdNm": "센터배송",
      "hdcCd": 10,
      "invNo": 123456789,
      "ordSaleTypCd": 10,
      "goodsNo": 100000001,
      "goodsNm": "상품명",
      "itmNm": "파랑",
      "prestNm": "우산 증정",
      "ordQty": 1,
      "shipQty": 1,
      "shipNeedQty": 1,
      "norPrc": 2500,
      "salePrc": 2500,
      "entrNm": "협력사1",
      "loginId": "x2admin",
      "mbrNo": 100001311,
      "ordManNm": "홍길동",
      "rcvmnNm": "홍길동",
      "rcvmnCellNo": "010-xxxx-5678",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": 1234,
      "rcvmnCellEndNo": 3546,
      "addr": "서울 송파구 법원로9길 26 에이치비지니스파크 D동 6층",
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "에이치비지니스파크 D동 6층",
      "deliMsgNm": "배송 전 연락 바랍니다",
      "deliMsg": "벨X, 노크X",
      "deliIndiDtm": "2023-12-31 00:00:00",
      "shipIndiDtm": "2023-12-31 00:00:00",
      "shipFnshDtm": "2023-12-31 00:00:00",
      "deliFnshDtm": "2023-12-31 00:00:00",
      "prstStatCd": 20,
      "prstMsg": "생일축하해",
      "ordMediaCdNm": "모바일웹",
      "siteNm": "플래티어닷컴",
      "ordFnshDtm": "2023-12-31 00:00:00"
    }
  ]
}

배송목록조회

get

기능설명

           * 배송목록을 조회합니다.
           ---
           ## 상세설명
           * 배송조회 화면의 배송목록을 조회합니다.
           * 주문수량이 유효한 주문만 조회합니다.(주문수량 - 취소수량 > 0)
           * 주문내역상태(OM005)가 주문취소(13), 반품취소(33), 반품완료(37)인 건은 조회하지 않습니다.
           * 유입경로가 PO인 경우에는 해당 협력사 데이터만 조회합니다.
           * 응답값 중 개인정보는 마스킹 처리됩니다.
           ---
           ## 수정번호
           * Release v2.00_240729 : 배송처리유형코드명 추가

• Release v2.00_240829 : 기본주소 마스킹 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchDateTypeStringRequired

조회기간구분

startDateLocalDateRequired

조회기간(시작일)

endDateLocalDateRequired

조회기간(종료일)

ordDtlStatCdStringOptional

주문내역상태(OM005)

searchDeliveryTypeStringRequired

배송정보구분

deliveryValStringOptional

배송정보입력값

deliTypCdStringOptional

배송유형(LO002)

deliProcTypCdStringOptional

배송처리유형(PR008)

searchOrdManTypeStringRequired

주문자정보구분

ordManValStringOptional

주문자정보입력값

deliKindCdStringOptional

배송종류코드(LO009)

ordSaleTypCdStringOptional

주문판매유형(OM004)

entrNoStringOptional

협력사번호

hdcCdStringOptional

택배사(LO005)

ordMediaCdStringOptional

주문매체(OM007)

deliNoStringOptional

배송번호

siteNoStringOptional

사이트번호

Responses

200

배송목록 조회 성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryInquiry/getDeliveryInquiryList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryInquiry/getDeliveryInquiryList?deliveryInquiryRequest=[object+Object]&searchDateType=null&startDate=null&endDate=null&searchDeliveryType=null&searchOrdManType=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230816O009106",
      "ordSeq": 1,
      "deliNo": 100016628,
      "ordAccpDtm": "2023-12-31 00:00:00",
      "ordGbCd": 10,
      "deliSeq": 1,
      "ordDtlStatCd": 22,
      "deliDtlStatCd": 12,
      "ordDtlGbCd": 10,
      "deliTypCd": 10,
      "deliKindCd": 10,
      "deliProcTypCd": 10,
      "deliProcTypCdNm": "센터배송",
      "hdcCd": 10,
      "invNo": 123456789,
      "ordSaleTypCd": 10,
      "goodsNo": 100000001,
      "goodsNm": "상품명",
      "itmNm": "파랑",
      "prestNm": "우산 증정",
      "ordQty": 1,
      "shipQty": 1,
      "shipNeedQty": 1,
      "norPrc": 2500,
      "salePrc": 2500,
      "entrNm": "협력사1",
      "loginId": "x2admin",
      "mbrNo": 100001311,
      "ordManNm": "홍길동",
      "rcvmnNm": "홍길동",
      "rcvmnCellNo": "010-xxxx-5678",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": 1234,
      "rcvmnCellEndNo": 3546,
      "addr": "서울 송파구 법원로9길 26 에이치비지니스파크 D동 6층",
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "에이치비지니스파크 D동 6층",
      "deliMsgNm": "배송 전 연락 바랍니다",
      "deliMsg": "벨X, 노크X",
      "deliIndiDtm": "2023-12-31 00:00:00",
      "shipIndiDtm": "2023-12-31 00:00:00",
      "shipFnshDtm": "2023-12-31 00:00:00",
      "deliFnshDtm": "2023-12-31 00:00:00",
      "prstStatCd": 20,
      "prstMsg": "생일축하해",
      "ordMediaCdNm": "모바일웹",
      "siteNm": "플래티어닷컴",
      "ordFnshDtm": "2023-12-31 00:00:00"
    }
  ]
}

배송상세정보조회

get

기능설명

           * 배송상세 정보를 조회합니다.
           ---
           ## 상세설명
           * 배송번호를 이용해 주문자정보 및 배송상세정보를 조회합니다.
           * 주문수량이 유효한 주문만 조회합니다.(주문수량 - 취소수량 > 0)
           * 주문내역상태(OM005)가 주문취소(13), 반품취소(33), 반품완료(37)인 건은 조회하지 않습니다.
           * 유입경로가 PO인 경우에는 해당 협력사 데이터만 조회합니다.
           * 응답값 중 개인정보는 마스킹 처리됩니다.
           ---
           ## 수정번호
           * Release v2.00_240729 : 배송처리유형코드명 추가
           * Release v2.00_241118 : 배송상세는 필드 마스킹 미처리

• Release v2.00_240829 : 기본주소 마스킹 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

deliNoStringRequired

배송번호

Responses

200

배송 상세정보 조회 성공

*/*

배송상세 응답 DTO

ordNostringOptional

주문번호

Example: 20230816O009106

deliNostringOptional

배송번호

Example: 100016628

ordAccpDtmstring · date-timeOptional

주문접수일시

Example: 2023-12-31 00:00:00

ordGbCdstring · enumOptional

주문구분코드(OM002)

Example: 10Possible values:

ordDtlStatCdstringOptional

주문내역상태(OM005)

Example: 22

ordDtlGbCdstringOptional

주문내역구분코드

Example: 10

deliTypCdstringOptional

배송유형(LO002)

Example: 10

deliKindCdstringOptional

배송종류(LO009)

Example: 10

deliProcTypCdstringOptional

배송처리유형코드(PR008)

Example: 10

deliProcTypCdNmstringOptional

배송처리유형코드명(PR008)

Example: 센터배송

ordManNmstringOptional

주문자명

Example: 홍길동

rcvmnNmstringOptional

수취인명

Example: 홍길동

rcvmnCellNostringOptional

수취인 휴대폰 번호

Example: 010-xxxx-5678

rcvmnCellSctNostringOptional

수취인 휴대폰 구분번호

Example: 010

rcvmnCellTxnoNostringOptional

수취인 휴대폰 국번번호

Example: 1234

rcvmnCellEndNostringOptional

수취인휴대폰끝번호

Example: 3546

addrstringOptional

주소

Example: 서울 송파구 법원로9길 26 에이치비지니스파크 D동 6층

zipAddrstringOptional

우편주소

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

dtlAddrstringOptional

상세주소

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

deliMsgNmstringOptional

배송메시지코드명(ME039)

Example: 배송 전 연락 바랍니다

deliMsgstringOptional

배송메시지

Example: 벨X, 노크X

prstStatCdstringOptional

선물상태코드(OM044)

Example: 20

prstMsgstringOptional

선물메시지

Example: 생일축하해

persCstmCdstringOptional

통관고유번호

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryInquiry/getDeliveryDetail

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryInquiry/getDeliveryDetail?deliveryInquiryRequest=[object+Object]&deliNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ordNo": "20230816O009106",
  "deliNo": 100016628,
  "ordAccpDtm": "2023-12-31 00:00:00",
  "ordGbCd": 10,
  "ordDtlStatCd": 22,
  "ordDtlGbCd": 10,
  "deliTypCd": 10,
  "deliKindCd": 10,
  "deliProcTypCd": 10,
  "deliProcTypCdNm": "센터배송",
  "ordManNm": "홍길동",
  "rcvmnNm": "홍길동",
  "rcvmnCellNo": "010-xxxx-5678",
  "rcvmnCellSctNo": "010",
  "rcvmnCellTxnoNo": 1234,
  "rcvmnCellEndNo": 3546,
  "addr": "서울 송파구 법원로9길 26 에이치비지니스파크 D동 6층",
  "zipAddr": "서울 송파구 법원로9길 26",
  "dtlAddr": "에이치비지니스파크 D동 6층",
  "deliMsgNm": "배송 전 연락 바랍니다",
  "deliMsg": "벨X, 노크X",
  "prstStatCd": 20,
  "prstMsg": "생일축하해",
  "persCstmCd": "text"
}