Collection Processing

Update Retrieval Status

post

Function Description

Updates the retrieval status.

Detailed Description

The retrieval status is updated when the Retrieval Instruction button is clicked on the BO Retrieval Confirmation screen, or when the Retrieval Complete button is clicked on the Retrieval Complete screen.
The status is updated by calling the Retrieval Status Update API in API-ORDER.
Current Order History Status (OM005), Order History Status to Update (OM005), and the target list for retrieval progress status update are required.

Revision History

Release v2.00_240729 : Allowed null for Courier Code (hdcCd) and Invoice No. (invNo) in the case of e-coupon delivery

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Retrieval Status Update Request DTO

ordDtlStatCdstring · min: 1Required

Current Order Progress Status (OM005)

Example: 32

updateTargetOrdDtlStatCdstring · min: 1Required

Order Progress Status to Update (OM005)

Example: 34

Responses

200

Retrieval Status Update Successful

No content

900

Business processing error details

*/*

post/v1/delivery/withdrawMgmt/saveWithdrawStatUpdateProcess

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

{
  "ordDtlStatCd": 32,
  "updateTargetOrdDtlStatCd": 34,
  "withdrawStatUpdateSaveInfoList": [
    {
      "ordNo": "20230816O009106",
      "deliNo": 100016628,
      "hdcCd": 10,
      "invNo": 123456789,
      "wthdFnshGbCd": 10,
      "wthdYn": "Y"
    }
  ]
}

No content

Process Retrieval Instruction

post

Function Description

Processes the retrieval instruction.

Detailed Content

The retrieval instruction is processed when the Retrieval Instruction button is clicked on the BO Retrieval Instruction Processing screen.
The retrieval instruction is processed by calling the Retrieval Instruction Processing API in API-ORDER.
The retrieval instruction target list is required.
Changes orders whose order history status (OM005) is Return Accepted (32) to Retrieval Instructed (34) status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Retrieval Instruction Target Processing Request DTO

Responses

200

Retrieval Instruction Processing Successful

No content

900

Business processing error details

*/*

post/v1/delivery/withdrawMgmt/saveWithdrawInstructHandlingList

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

{
  "withdrawInstructHandlingSaveInfoList": [
    {
      "ordNo": "20230816O009106",
      "deliNo": 100016628,
      "rtnQty": 1
    }
  ]
}

No content

Return Processing During Exchange

post

Function Description

Processes conversion to return.

Detailed Description

Conversion to return during exchange is processed when the Convert to Return button is clicked on the BO Retrieval Complete Processing screen.
This is processed by calling the Convert to Return API in API-ORDER.
Order No., Claim No., and Order Channel Code are required.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Convert to Return Request DTO

ordNostring · min: 1Required

Order No.

Example: 20230808O007404

claimNostring · min: 1Required

Claim No.

Example: 20230801C008072

ordMediaCdstring · min: 1Required

Order Channel Code (OM007)

Example: 30

Responses

200

Return Processing During Exchange Successful

No content

900

Business processing error details

*/*

post/v1/delivery/withdrawMgmt/returnTrnsformProcess

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

{
  "ordNo": "20230808O007404",
  "claimNo": "20230801C008072",
  "ordMediaCd": 30
}

No content

Process Return Not Possible

post

Function Description

Processes Return Not Possible.

Detailed Description

Return Not Possible is processed when the Return Not Possible button is clicked on the BO Retrieval Complete Processing screen.
This is processed by calling the Return Not Possible API in API-ORDER.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Return Not Possible Request DTO

ordNostring · min: 1Required

Order No.

Example: 20230808O007404

claimNostring · min: 1Required

Claim No.

Example: 20230801C008072

ordMediaCdstring · min: 1Required

Order Channel Code (OM007)

Example: 30

wthdFnshWaitProcCausstringOptional

Return Not Possible Reason

Example: 불량반품

Responses

200

Return Not Possible Processing Successful

No content

900

Business processing error details

*/*

post/v1/delivery/withdrawMgmt/noAllowedReturnProcess

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

{
  "ordNo": "20230808O007404",
  "claimNo": "20230801C008072",
  "ordMediaCd": 30,
  "wthdFnshWaitProcCaus": "불량반품"
}

No content

Retrieve Retrieval Information

get

Function Description

Retrieves retrieval data.

Detailed Content

Retrieves the list shown on the Retrieval Instruction Processing, Retrieval Confirmation Processing, and Retrieval Complete Processing screens.
Inquiry Period Type, Inquiry Start Date, Inquiry End Date, and Delivery Type are required.
The Retrieval Instruction Processing screen retrieves the order list in Accepted status, and the Retrieval Confirmation Processing screen retrieves the order list in Retrieval Instructed status.

Revision History

Release v2.00_240729 : Added Retrieval Status (wthdYn), Delivery Processing Type Code Name (deliProcTypCdNm), Non-Retrievable Order Status (isAllNonReturnable)
Release v2.01_240910 : Added retrieval of Delivery Type Code Name (deliTypCdNm), Order History Status Code Name (ordDtlStatCdNm), and Courier Name (hdcCdNm)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchPeriodTypeStringRequired

Search Period Type

startDateLocalDateRequired

Search Start Date

endDateLocalDateRequired

Search End Date

searchOrdDeliTypeStringOptional

Delivery Information

deliveryTypeStringOptional

Delivery Information Type

deliTypCdStringRequired

Delivery Type

deliTypCdNmStringRequired

Delivery Type Code Name

deliProcTypCdStringOptional

Delivery Processing Type

searchOrdManTypeStringOptional

Orderer Information Type

ordManValStringOptional

Orderer Information

deliKindCdStringOptional

Delivery Type Code

entrNoStringOptional

Vendor Information

ordDtlStatCdStringOptional

Order History Status

ordDtlStatCdNmStringOptional

Order Detail Status Code Name

ordDtlStatCdInputStringOptional

Order History Status on Retrieval Confirmation Screen (Retrieval Instructed)

targetOrdDtlStatCdStringOptional

Order History Status on Retrieval Confirmation Screen (Retrieval Confirmed)

wthdYnStringOptional

Collection Required Status

Responses

200

Retrieval Inquiry Successful

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v1/delivery/withdrawMgmt/getWithdrawList

GET /api/bo/v1/delivery/withdrawMgmt/getWithdrawList?withdrawSearchRequest=[object+Object]&searchPeriodType=null&startDate=null&endDate=null&deliTypCd=null&deliTypCdNm=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "ordNo": "20230808O007404",
      "ordMediaCd": 30,
      "deliNo": 100016628,
      "rtnAccpDtm": "2023-12-31 00:00:00",
      "ordFnshDtm": "2023-12-31 00:00:00",
      "deliTypCd": 10,
      "deliTypCdNm": "반품회수",
      "ordDtlGbCd": 30,
      "ordDtlStatCd": 34,
      "ordDtlStatCdNm": "회수지시",
      "deliProcTypCd": 10,
      "deliProcTypCdNm": "센터배송",
      "deliKindCd": 10,
      "ordSaleTypCd": 10,
      "entrNm": "플래티어 협력사",
      "loginId": "x2admin",
      "ordManNm": "홍길동",
      "ordManCellSctNo": "010",
      "ordManCellTxnoNo": 1234,
      "ordManCellEndNo": 5678,
      "rcvmnNm": "홍길동",
      "rcvmnCellSctNo": "010",
      "rcvmnCellTxnoNo": 1234,
      "rcvmnCellEndNo": 3546,
      "goodsNo": 100000001,
      "goodsNm": "상품이름",
      "itmNm": "파랑",
      "rtnQty": 1,
      "mbrNo": 100001311,
      "invNo": 123456789,
      "hdcCd": 10,
      "hdcCdNm": "우체국택배",
      "wthdFnshGbCd": 10,
      "claimNo": "20230801C008072",
      "wthdYn": "Y",
      "isAllNonReturnable": "Y",
      "shipIndiDtm": "2023-12-31 00:00:00",
      "deliIndiDtm": "2023-12-31 00:00:00",
      "shipCfmDtm": "2023-12-31 00:00:00"
    }
  ]
}

Retrieve Retrieval Detail Popup

get

Function Description

Retrieves retrieval detail popup information.

Detailed Description

Retrieves orderer information and return detail information using the delivery number.
If the inflow channel is PO, only the corresponding vendor's data is retrieved.
Personal information in the response is masked.

Revision History

Release v2.00_241122 : Added retrieval of Retrieval Required Status (wthdYn), and Order No. (ordNo), Order Sequence (ordSeq), and Order Processing Sequence (ordProcSeq) for calling the return/exchange reason popup
Release v2.00_2508829 : Added masking processing based on authorization status

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

deliNoStringRequired

Delivery No.

Responses

200

Retrieval Detail Popup Inquiry Successful

*/*

Retrieval Detail Response DTO

withdrawDeliNostringOptional

Collection Delivery No.

Example: 100016628

rtnAccpDtmstring · date-timeOptional

Return Reception Date/Time

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

ordNostringOptional

Order No.

Example: 20230808O007404

ordSeqinteger · int32Optional

Order Sequence No.

Example: 1

ordProcSeqinteger · int32Optional

Order Processing Sequence No.

Example: 1

ordFnshDtmstring · date-timeOptional

Order Completion Date/Time

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

deliTypCdstringOptional

Delivery Type Code Name (LO002)

Example: 10

deliTypCdNmstringOptional

Delivery Type Code Name (LO002)

Example: 정상출하

deliProcTypCdstringOptional

Delivery Processing Type Code (PR008)

Example: 10

deliProcTypCdNmstringOptional

Delivery Processing Type Code Name

Example: 센터배송

ordManNmstringOptional

Orderer Name

Example: 홍길동

ordManCellSctNostringOptional

Orderer's Mobile Phone Prefix Code

Example: 010

ordManCellTxnoNostringOptional

Orderer's Mobile Phone Exchange Code

Example: 1324

ordManCellEndNostringOptional

Orderer's Mobile Phone Last Digits

Example: 5678

rcvmnNmstringOptional

Recipient Name

Example: 홍길동

rcvmnCellSctNostringOptional

Recipient's Mobile Phone Prefix Code

Example: 010

rcvmnCellTxnoNostringOptional

Recipient's Mobile Phone Exchange Code

Example: 1324

rcvmnCellEndNostringOptional

Recipient's Mobile Phone Last Digits

Example: 5678

zipAddrstringOptional

Basic Address

Example: 서울시 강남구

dtlAddrstringOptional

Detailed Address

Example: 테헤란로 123

wthdYnstringOptional

Collection Required Status

Example: Y

900

Business processing error details

*/*

get/v1/delivery/withdrawMgmt/getWithdrawDetail

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

{
  "withdrawDeliNo": 100016628,
  "rtnAccpDtm": "2023-12-31 00:00:00",
  "ordNo": "20230808O007404",
  "ordSeq": 1,
  "ordProcSeq": 1,
  "ordFnshDtm": "2023-12-31 00:00:00",
  "deliTypCd": 10,
  "deliTypCdNm": "정상출하",
  "deliProcTypCd": 10,
  "deliProcTypCdNm": "센터배송",
  "ordManNm": "홍길동",
  "ordManCellSctNo": "010",
  "ordManCellTxnoNo": 1324,
  "ordManCellEndNo": 5678,
  "rcvmnNm": "홍길동",
  "rcvmnCellSctNo": "010",
  "rcvmnCellTxnoNo": 1324,
  "rcvmnCellEndNo": 5678,
  "zipAddr": "서울시 강남구",
  "dtlAddr": "테헤란로 123",
  "wthdYn": "Y",
  "withdrawDetailGoodsInfoList": [
    {
      "ordNo": "20230808O007404",
      "ordSeq": 1,
      "ordProcSeq": 1,
      "goodsNo": 10002042,
      "goodsNm": "상품명",
      "itmNm": "파랑",
      "puTypCd": "회수",
      "ordDtlStatCd": 10,
      "ordDtlStatCdNm": "접수",
      "hdcCd": "CJ대한통운",
      "invNo": 123456789,
      "claimCause": "유사상품 구매",
      "claimDtlCause": "text",
      "wthdFnshGbCd": "정상반품"
    }
  ]
}

PreviousUnsent Status

NextShipment Completed

Last updated 2 months ago