배송관리

결품처리

post

기능설명

• 결품관리 화면의 결품처리를 진행합니다.

---

상세설명

• 결품등록, 결품해제를 진행합니다.

• 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 결품처리 요청목록(insuffDeliveryProcessInfoList)은 필수로 있어야 합니다.

• 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)

  • 결품등록 : 22(출고지시) -> 23(출고대기)

  • 결품해제 : 23(출고대기) -> 22(출고지시)

• API-ORDER에 있는 결품처리 API를 호출하여 처리를 진행합니다.

• 결품 등록 후 고객센터 OB목록에 등록됩니다.

• 결품 등록 후 알림메시지(알림톡, 알림함)를 전송합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

결품처리요청 DTO

ordDtlStatCdstring · min: 1Required

원주문내역상태코드(OM005) 22:출고지시, 23:출고대기

Example: 22

targetOrdDtlStatCdstring · min: 1Required

처리주문내역상태코드(OM005) 22:출고지시, 23:출고대기

Example: 26

Responses

200

결품 처리 성공

No content

900

업무처리 오류 내용

*/*

post

/v1/delivery/deliveryCommon/processInsuffDelivery

HTTPcURLJavaScriptPython

POST /api/bo/v1/delivery/deliveryCommon/processInsuffDelivery HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 222

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

No content

배송처리

post

기능설명

• 배송관리 화면의 배송처리를 진행합니다.

---

상세설명

• 배송지시, 출고지시, 출고완료, 배송완료를 진행합니다.

• 원주문내역상태코드(ordDtlStatCd:OM005), 처리주문내역상태코드(targetOrdDtlStatCd:OM005), 배송처리 목록(deliveryProcessInfoList)은 필수로 있어야 합니다.

• 원주문내역상태코드(OM005) -> 처리주문내역상태코드(OM005)

  • 배송지시 : 12(주문완료) -> 21(배송지시)

  • 출고지시 : 21(배송지시) -> 22(출고지시)

  • 출고완료 : 22(출고지시) -> 26(출고완료)

  • 배송완료 : 26(출고완료) -> 27(배송완료)

• API-ORDER에 있는 배송처리 API를 호출하여 처리를 진행합니다.

• 배송 처리 후 알림메시지(알림톡, 알림함, 이메일)를 전송합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

배송처리 요청 DTO

ordDtlStatCdstring · enum · min: 1Required

원주문내역상태코드(OM005)

Example: 22Possible values:

targetOrdDtlStatCdstring · enum · min: 1Required

처리주문내역상태코드(OM005)

Example: 26Possible values:

deliDtlStatCdstringOptional

원배송내역상태코드(LO016)

Example: 22

targetDeliDtlStatCdstringOptional

처리배송내역상태코드(LO016)

Example: 26

Responses

200

배송 처리 성공

No content

900

업무처리 오류 내용

*/*

post

/v1/delivery/deliveryCommon/processDelivery

HTTPcURLJavaScriptPython

POST /api/bo/v1/delivery/deliveryCommon/processDelivery HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "ordDtlStatCd": 22,
  "targetOrdDtlStatCd": 26,
  "deliDtlStatCd": 22,
  "targetDeliDtlStatCd": 26,
  "deliveryProcessInfoList": [
    {
      "ordNo": "20230816O009106",
      "ordSeq": 1,
      "shipQty": 1,
      "deliSeq": 1,
      "deliNo": 100016628,
      "hdcCd": 10,
      "invNo": 123456789,
      "alimYn": "Y"
    }
  ]
}

No content

배송처리목록조회

get

기능설명

• 배송처리 화면의 배송목록을 조회합니다.

---

상세설명

• 배송지시처리, 출고지시처리, 출고완료처리, 배송완료처리, 결품처리 화면에서 사용합니다.

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

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

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

• 조회기간은 최대 30일까지만 조회 가능합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchDateTypeStringRequired

조회기간구분

startDateLocalDateRequired

조회기간(시작일)

endDateLocalDateRequired

조회기간(종료일)

searchOrdDtlStatCdStringOptional

주문내역상태(OM005)

searchDeliveryTypeStringOptional

배송정보구분

deliveryValStringOptional

배송정보입력값

deliKindCdStringOptional

배송종류코드(LO009)

entrNoStringOptional

협력사번호

searchOrdManTypeStringOptional

주문자정보구분

ordManValStringOptional

주문자정보입력값

deliProcTypCdStringOptional

배송처리유형(PR008)

hdcCdStringOptional

택배사(LO005)

shipWaitCausStringOptional

출고대기사유(LO007)

Responses

200

배송관리 목록 조회 성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryCommon/getDeliveryMgmtList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryCommon/getDeliveryMgmtList?deliveryMgmtCommonRequest=[object+Object]&searchDateType=null&startDate=null&endDate=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230816O009106",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "deliNo": 100016628,
      "deliSeq": 1,
      "ordGbCd": 10,
      "ordAccpDtm": "2023-12-31 00:00:00",
      "ordDtlGbCd": 10,
      "ordDtlStatCd": 22,
      "ordDtlStatCdNm": "배송완료",
      "deliKindCd": 10,
      "deliProcTypCd": 10,
      "hdcCd": 10,
      "hdcCdNm": "CJ대한통운",
      "invNo": 123456789,
      "ordSaleTypCd": 10,
      "partShipYn": "Y",
      "goodsNo": 100000001,
      "goodsNm": "상품명",
      "itmNo": "001",
      "itmNm": "파랑",
      "prestNm": "우산 증정",
      "ordQty": 1,
      "preShipQty": 1,
      "shipNeedQty": 1,
      "shipQty": 1,
      "norPrc": 2500,
      "salePrc": 2500,
      "entrNm": "협력사1",
      "loginId": "x2admin",
      "mbrNo": 100001311,
      "ordManNm": "홍길동",
      "ordManCellNo": "010-xxxx-5678",
      "ordManCellSctNo": "010",
      "ordManCellTxnoNo": 1234,
      "ordManCellEndNo": 3546,
      "rcvmnNm": "홍길동",
      "rcvmnCellNo": "010-xxxx-5678",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": 1234,
      "rcvmnCellEndNo": 3546,
      "zipAddr": "서울 송파구 법원로9길 26",
      "dtlAddr": "에이치비지니스파크 D동 6층",
      "deliMsgCd": "배송 전 연락 바랍니다",
      "deliMsg": "벨X, 노크X",
      "deliIndiDtm": "2023-12-31 00:00:00",
      "shipWaitCaus": "재고있지만출고불가능",
      "shipWaitCausCont": "불량품",
      "shipWaitDtm": "2023-12-31 00:00:00",
      "insuffElpsdDay": 1,
      "insuffQty": 1,
      "shipIndiDtm": "2023-12-31 00:00:00",
      "shipFnshDtm": "2023-12-31 00:00:00",
      "ordFnshDtm": "2023-12-31 00:00:00"
    }
  ]
}