> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/claim-bo-api/order-claim-processing.md).
# Order Claim Processing
## Register Non-Member Refund Account
> \## Function Description\
> \* Registers a refund account for a non-member.\
> \---\
> \## Detailed Description\
> \---\
> \## Notes\
> \* The account holder name must match the orderer's name.\
> \* Account verification must be completed.\
> \* Required value list\
> \* Account Number\
> \* Bank Code\
> \* Account Verification Status
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RefundAcceptRegisterRequest":{"type":"object","properties":{"rfdNo":{"type":"string"},"ordNo":{"type":"string"},"mbrNo":{"type":"string","minLength":1},"mbrNm":{"type":"string","minLength":1},"loginId":{"type":"string","minLength":1},"rfdTypCd":{"type":"string","minLength":1},"rfdPrgsStatCd":{"type":"string","minLength":1},"rfdBankCd":{"type":"string","minLength":1},"rfdActnNo":{"type":"string","minLength":1},"rfdActnDepositorNm":{"type":"string","minLength":1},"rfdCausCd":{"type":"string","minLength":1},"rfdActnCertiYn":{"type":"string","minLength":1},"rfdAmt":{"type":"number"},"rfdCmsnAmt":{"type":"number"},"acptmnId":{"type":"string","minLength":1},"rfdSmsSndYn":{"type":"string","minLength":1}},"required":["acptmnId","loginId","mbrNm","mbrNo","rfdActnCertiYn","rfdActnDepositorNm","rfdActnNo","rfdAmt","rfdBankCd","rfdCausCd","rfdCmsnAmt","rfdPrgsStatCd","rfdSmsSndYn","rfdTypCd"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/saveNonMemberRefundActn":{"post":{"tags":["Order Claim Processing"],"summary":"Register Non-Member Refund Account","description":"## Function Description\n* Registers a refund account for a non-member.\n---\n## Detailed Description\n---\n## Notes\n* The account holder name must match the orderer's name.\n* Account verification must be completed.\n* Required value list\n * Account Number\n * Bank Code\n * Account Verification Status\n","operationId":"saveNonMemberRefundActn","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundAcceptRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Promotion Information from Order Claim Payment/Refund Information in Order Management
> \## Function Description\
> \* Retrieves the promotion information used (coupon, discount, accrued mileage) corresponding to the order number.\
> \---\
> \## Detailed Description\
> \* Retrieves the promotion information used (coupon, discount, accrued mileage) corresponding to the order number.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DepositNotifyRequest":{"type":"object","properties":{"ordNo":{"type":"string","description":"Order No.","minLength":1}},"required":["ordNo"]},"DepositNotifyResult":{"type":"object","description":"Virtual Account Deposit Confirmation Processing Response","properties":{"result":{"type":"string"},"alreadyConfirmed":{"type":"boolean"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/saveManualConfirm":{"post":{"tags":["Order Claim Processing"],"summary":"Retrieve Promotion Information from Order Claim Payment/Refund Information in Order Management","description":" ## Function Description\n * Retrieves the promotion information used (coupon, discount, accrued mileage) corresponding to the order number.\n ---\n ## Detailed Description\n * Retrieves the promotion information used (coupon, discount, accrued mileage) corresponding to the order number.\n","operationId":"saveManualConfirm","parameters":[{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositNotifyRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DepositNotifyResult"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Changes the delivery address.
> \## Function Description\
> \* Changes the delivery address.\
> \---\
> \## Detailed Description\
> \* The delivery address can be changed when the order history type code (OM003) is Order Complete (11).\
> \* Updates all delivery sequence numbers for the corresponding order number, regardless of delivery number.\
> \* Only delivery address changes between remote island/mountainous areas incurring additional shipping fees, or between general areas, are allowed.\
> \---\
> \## Notes\
> \* The delivery address change availability status may vary depending on the ref\_1\_val (OM005) and ref\_2\_val (OM003) values of ST008 cd 92 (Delivery Address Change).\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240711\`\`\` : Added delivery policy number (deli\_polc\_no) due to the additional shipping fee improvement
````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DeliveryInfoChangeRequest":{"type":"object","description":"Order Delivery Address Change DTO","properties":{"ordNo":{"type":"string","description":"Order No.","minLength":1},"systemType":{"type":"string","description":"System Classification Code"},"deliNo":{"type":"string","description":"Delivery No.","minLength":1},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name","minLength":1},"zipNoSeq":{"type":"integer","format":"int32","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"originZipNo":{"type":"string","description":"Original Order Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code","minLength":1},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code","minLength":1},"rcvmnCellEndNo":{"type":"string","description":"Recipient's Mobile Phone Last Digits","minLength":1},"deliMsg":{"type":"string","description":"Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code"},"deliGbCd":{"type":"string","description":"Delivery Type Code"},"dlvpSeq":{"type":"string","description":"Delivery Sequence No."},"rcvmnEmailAddr":{"type":"string","description":"Recipient Email"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient's Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient's Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient's Phone Last Digits"},"orginDlvpSeq":{"type":"string","description":"Original Delivery Sequence No."}},"required":["deliNo","ordNo","rcvmnCellEndNo","rcvmnCellSctNo","rcvmnCellTxnoNo","rcvmnNm"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/ordDlvChange":{"post":{"tags":["Order Claim Processing"],"summary":"Changes the delivery address.","description":" ## Function Description\n * Changes the delivery address.\n ---\n ## Detailed Description\n * The delivery address can be changed when the order history type code (OM003) is Order Complete (11).\n * Updates all delivery sequence numbers for the corresponding order number, regardless of delivery number.\n * Only delivery address changes between remote island/mountainous areas incurring additional shipping fees, or between general areas, are allowed.\n ---\n ## Notes\n * The delivery address change availability status may vary depending on the ref_1_val (OM005) and ref_2_val (OM003) values of ST008 cd 92 (Delivery Address Change).\n ---\n ## Revision History\n * ```Release v2.00_240711``` : Added delivery policy number (deli_polc_no) due to the additional shipping fee improvement\n","operationId":"modifyOrdDlvChange","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryInfoChangeRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Order Change > Changes the item (SKU) of an ordered product.
> \## Function Description\
> \* Changes the item (SKU) of an ordered product.\
> \---\
> \## Detailed Description\
> \* The option can be changed when the order history type code (OM003) is Order Complete (11).\
> \* Multiple option changes are allowed.\
> \* Can be changed to a color + size combination of an item that is On Sale, has stock, and is the same price.\
> \* The item cannot be changed to the same item or to an item of a reserved product.\
> \---\
> \## Notes\
> \* The delivery address change availability status may vary depending on the ref\_1\_val (OM005) and ref\_2\_val (OM003) values of ST008 cd 91 (Option Change).
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrdGoodsInfoRequest":{"type":"object","description":"Item (SKU) Change DTO","properties":{"ordNo":{"type":"string","description":"Order No.","minLength":1},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNo":{"type":"string","description":"Product No. Sequence No.","minLength":1},"itmNo":{"type":"string","description":"Item No.","minLength":1},"chngItmNo":{"type":"string","description":"Changed SKU No.","minLength":1},"ordQty":{"type":"integer","format":"int32","description":"Quantity"},"salePrc":{"type":"number","description":"Selling Price"},"goodsNm":{"type":"string","description":"Product Name"}},"required":["chngItmNo","goodsNo","itmNo","ordNo","ordProcSeq","ordSeq"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/ordChange":{"post":{"tags":["Order Claim Processing"],"summary":"Order Change > Changes the item (SKU) of an ordered product.","description":" ## Function Description\n * Changes the item (SKU) of an ordered product.\n ---\n ## Detailed Description\n * The option can be changed when the order history type code (OM003) is Order Complete (11).\n * Multiple option changes are allowed.\n * Can be changed to a color + size combination of an item that is On Sale, has stock, and is the same price.\n * The item cannot be changed to the same item or to an item of a reserved product.\n ---\n ## Notes\n * The delivery address change availability status may vary depending on the ref_1_val (OM005) and ref_2_val (OM003) values of ST008 cd 91 (Option Change).\n","operationId":"ordChange","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrdGoodsInfoRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Change > Retrieves the order delivery address list.
> \## Function Description\
> \* Retrieves the order delivery address.\
> \---\
> \## Detailed Description\
> \* Retrieves the order delivery address.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240827\`\`\`: Retrieves the order delivery address list by order number\
> \* \`\`\`Release v2.00\_240829\`\`\`: Updated masking processing
````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DeliveryDetailRequest":{"type":"object","properties":{"ordNo":{"type":"string"},"deliNo":{"type":"string"},"dlvpSeq":{"type":"string"}}},"OrderChangeDlvpResponse":{"type":"object","description":"Order Delivery Address Inquiry DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"dlvpSeq":{"type":"string","description":"Delivery Sequence No."},"deliNo":{"type":"string","description":"Delivery No."},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient's Mobile Phone Last Digits"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient's Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient's Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient's Phone Last Digits"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"deliMsg":{"type":"string","description":"Delivery Message"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"deliRegnGrpYn":{"type":"string","description":"Remote Island/Mountainous Area Status"},"deliGbCd":{"type":"string","description":"Delivery Type Code (LO001)"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"ordDtlStatNm":{"type":"string","description":"Order History Status"},"ordDtlGbNm":{"type":"string","description":"Order History Type"},"ordGbCd":{"type":"string","description":"Order Type Code"},"ordGbNm":{"type":"string","description":"Order Type"},"ordPrc":{"type":"integer","format":"int64","description":"Order Amount"},"goodsTypNm":{"type":"string","description":"Product Type"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"frgnDirPurGoodsYn":{"type":"string","description":"Direct Purchase Product Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrderChangeDlvp":{"post":{"tags":["Order Claim Processing"],"summary":"Order Change > Retrieves the order delivery address list.","description":" ## Function Description\n * Retrieves the order delivery address.\n ---\n ## Detailed Description\n * Retrieves the order delivery address.\n ---\n ## Revision History\n * ```Release v2.00_240827```: Retrieves the order delivery address list by order number\n * ```Release v2.00_240829```: Updated masking processing\n","operationId":"getOrderChangeDlvpList","parameters":[{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryDetailRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderChangeDlvpResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Retrieves whether the location is a remote island/mountainous area.
> \## Function Description\
> \* Retrieves whether the location is a remote island/mountainous area.\
> \---\
> \## Detailed Description\
> \* Retrieves whether the location is a remote island/mountainous area.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DeliveryRegionRequest":{"type":"object","description":"Remote Island/Mountainous Area Inquiry DTO","properties":{"zipNo":{"type":"string","description":"New Postal Code"},"originZipNo":{"type":"string","description":"Previous Postal Code"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/deliveryRegionCheck":{"post":{"tags":["Order Claim Processing"],"summary":"Retrieves whether the location is a remote island/mountainous area.","description":" ## Function Description\n * Retrieves whether the location is a remote island/mountainous area.\n ---\n ## Detailed Description\n * Retrieves whether the location is a remote island/mountainous area.\n","operationId":"deliveryRegionCheck","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryRegionRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Payment/Refund Status Popup
> \## Function Description\
> \* Retrieves the payment/refund history list of the corresponding order when the Payment/Refund Status button is clicked in the Payment/Refund Information section of the Order Management > Order Claim Processing screen.\
> \---\
> \## Detailed Description\
> \* This is payment data that accumulates when a payment/refund amount exceeding 0 KRW occurs via the primary payment method or secondary payment method.\
> \---\
> \## Revision History\
> \* Release v2.00\_240829 : Added postal address masking
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PaymentMgmtPopupRequest":{"type":"object","properties":{"ordNo":{"type":"string"}}},"RealGridListResponsePaymentRefundPrcondResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PaymentRefundPrcondResponse"}}}},"PaymentRefundPrcondResponse":{"type":"object","properties":{"payGbNm":{"type":"string","description":"Payment Type"},"payWayCd":{"type":"string","description":"Payment Method Code (OM013) 11: Credit Card, 12: Real-time Account Transfer, 32: Mileage"},"payWayNm":{"type":"string","description":"Payment/Refund Method"},"payStatNm":{"type":"string","description":"Payment/Refund Status"},"payFnshDtm":{"type":"string","format":"date-time","description":"Payment/Refund Completion Date"},"payAmt":{"type":"number","description":"Payment Amount"},"methodType":{"type":"string","description":"Payment Method Type"},"cardBank":{"type":"string","description":"Card/Bank Name"},"cardNo":{"type":"string","description":"Card No."},"actnNo":{"type":"string","description":"Account Number"},"mid":{"type":"string","description":"MID"},"dpmnNm":{"type":"string","description":"Depositor/Account Holder"},"dptFcstDt":{"type":"string","description":"Scheduled Deposit Date"},"dptCnfmDtm":{"type":"string","format":"date-time","description":"Deposit Confirmation Date/Time"},"aprvNo":{"type":"string","description":"Approval No."},"nintDivYn":{"type":"string","description":"Installment Status"},"divMonCnt":{"type":"integer","format":"int32","description":"Installment Months"},"claimNo":{"type":"string","description":"Claim No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getPaymentRefundPrcondList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Payment/Refund Status Popup","description":" ## Function Description\n * Retrieves the payment/refund history list of the corresponding order when the Payment/Refund Status button is clicked in the Payment/Refund Information section of the Order Management > Order Claim Processing screen.\n ---\n ## Detailed Description\n * This is payment data that accumulates when a payment/refund amount exceeding 0 KRW occurs via the primary payment method or secondary payment method.\n ---\n ## Revision History\n * Release v2.00_240829 : Added postal address masking\n","operationId":"getPaymentRefundPrcondList","parameters":[{"name":"paymentMgmtPopupRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PaymentMgmtPopupRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePaymentRefundPrcondResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Change > Retrieves products eligible for option change.
> \## Function Description\
> \* Retrieves the list of products eligible for option change among the current order products.\
> \---\
> \## Detailed Description\
> \* Retrieves the list of products eligible for option change among the current order products.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240711\`\`\`: Added delivery policy number (deli\_polc\_no) inquiry due to the additional shipping fee improvement
````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"RealGridListResponseOrderChangeItmResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderChangeItmResponse"}}}},"OrderChangeItmResponse":{"type":"object","description":"Order Change Current Order Product Changeable Item (SKU) List Inquiry DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"deliNo":{"type":"string","description":"Delivery No."},"dlvpSeq":{"type":"string","description":"Delivery Sequence No."},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"salePrc":{"type":"number","description":"Selling Price"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"ordSaleTypNm":{"type":"string","description":"Order Sales Type (OM004)"},"ordDtlStatCd":{"type":"string","description":"Order Detail Status Code (OM005)"},"ordDtlStatNm":{"type":"string","description":"Order Detail Status Name"},"ordManNm":{"type":"string","description":"Orderer Name"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrderChangeItmList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Change > Retrieves products eligible for option change.","description":" ## Function Description\n * Retrieves the list of products eligible for option change among the current order products.\n ---\n ## Detailed Description\n * Retrieves the list of products eligible for option change among the current order products.\n ---\n ## Revision History\n * ```Release v2.00_240711```: Added delivery policy number (deli_polc_no) inquiry due to the additional shipping fee improvement\n","operationId":"getOrderChangeItmList","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderChangeItmResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Retrieve Promotion Information from Order Claim Payment/Refund Information in Order Management
> \## Function Description\
> \* Retrieves the promotion information used (coupon, discount, accrued mileage) corresponding to the order number.\
> \---\
> \## Detailed Description\
> \* Retrieves the promotion information used (coupon, discount, accrued mileage) corresponding to the order number.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"OrderClaimPromotionInfoResponse":{"type":"object","description":"Order Claim Processing Promotion Information Inquiry DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"cpnGoodsDcGoodsNm":{"type":"string","description":"Product Discount Coupon Product Name"},"cpnGoodsDcAmt":{"type":"integer","format":"int32","description":"Product Discount Coupon"},"cpnCartDcAmt":{"type":"integer","format":"int32","description":"Cart Coupon"},"stafDcAmt":{"type":"integer","format":"int32","description":"Employee Discount"},"cpnOvrlpDcAmt":{"type":"integer","format":"int32","description":"Stackable Discount Coupon"},"cpnFreeDlvrycAmt":{"type":"integer","format":"int32","description":"Free Shipping Coupon"},"cpnFreeRtnDlvrycAmt":{"type":"integer","format":"int32","description":"Free Return Shipping Coupon"},"acclmMileageAmt":{"type":"integer","format":"int32","description":"Accrued Mileage"},"goodsDirectAmt":{"type":"integer","format":"int32","description":"Instant Product Discount"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcPromotionInfo":{"get":{"tags":["Order Claim Processing"],"summary":"Retrieve Promotion Information from Order Claim Payment/Refund Information in Order Management","description":" ## Function Description\n * Retrieves the promotion information used (coupon, discount, accrued mileage) corresponding to the order number.\n ---\n ## Detailed Description\n * Retrieves the promotion information used (coupon, discount, accrued mileage) corresponding to the order number.\n","operationId":"getOrdClmProcPromotionInfo","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderClaimPromotionInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Payment Method Information from Payment/Refund Information
> \## Function Description\
> \* Retrieves the payment method information corresponding to the order number.\
> \---\
> \## Detailed Description\
> \* Retrieves the payment method information corresponding to the order number.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"OrderClaimPayWayInfoResponse":{"type":"object","description":"Payment Method Information Inquiry DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"payWayCd":{"type":"string","description":"Payment Method Code (OM013)"},"payWayCdNm":{"type":"string","description":"Payment Method Code Name"},"lclPayAmt":{"type":"string","description":"Local Payment Amount"},"payStatCd":{"type":"string","description":"Payment Status Code (OM014)"},"payStatCdNm":{"type":"string","description":"Payment Status Code Name"},"bankCd":{"type":"string","description":"Bank Code (OM026)"},"bankCdNm":{"type":"string","description":"Bank Code Name (OM026)"},"actnNo":{"type":"string","description":"Account Number"},"dpmnNm":{"type":"string","description":"Depositor Name"},"dptFcstDt":{"type":"string","description":"Scheduled Deposit Date"},"dptCnfmDtm":{"type":"string","format":"date-time","description":"Deposit Confirmation Date/Time"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcPayWayInfoList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Payment Method Information from Payment/Refund Information","description":" ## Function Description\n * Retrieves the payment method information corresponding to the order number.\n ---\n ## Detailed Description\n * Retrieves the payment method information corresponding to the order number.\n","operationId":"getOrdClmProcPayWayInfoList","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimPayWayInfoResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Payment Detail Information from Payment/Refund Information
> \## Function Description\
> \* Retrieves the payment detail information corresponding to the order number.\
> \---\
> \## Detailed Description\
> \* Retrieves the payment detail information, along with the unpaid amount, refund pending amount, unrefunded amount, and payment/refund error amount.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"OrderClaimPayDtlInfoResponse":{"type":"object","description":"Payment Detail Information Inquiry DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"nonPayAmt":{"type":"integer","format":"int32","description":"Unpaid Amount"},"rfndWaitAmt":{"type":"integer","format":"int32","description":"Refund Pending Amount"},"nonRfndAmt":{"type":"integer","format":"int32","description":"Unrefunded Amount"},"rfndErrorAmt":{"type":"integer","format":"int32","description":"Refund Error Amount"},"goodsAmt":{"type":"integer","format":"int32","description":"Product Amount"},"dcAmt":{"type":"number","description":"Discount Amount"},"dlvryChrg":{"type":"integer","format":"int32","description":"Delivery Fee"},"payAmt":{"type":"number","description":"Payment Amount"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcPayDtlInfo":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Payment Detail Information from Payment/Refund Information","description":" ## Function Description\n * Retrieves the payment detail information corresponding to the order number.\n ---\n ## Detailed Description\n * Retrieves the payment detail information, along with the unpaid amount, refund pending amount, unrefunded amount, and payment/refund error amount.\n","operationId":"getOrdClmProcPayDtlInfo","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderClaimPayDtlInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Order Information and Member Information
> \## Function Description\
> \* Retrieves the order information and orderer information of the order row selected from the order list.\
> \---\
> \## Detailed Description\
> \* Retrieves the order information and orderer information using the order number of the selected order row.\
> \* For members only, the coupon count is retrieved via the Promotion API, and the currently available mileage is retrieved via the Member API.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"OrderClaimOrdMbrInfoResponse":{"type":"object","description":"Order Information and Member Information Inquiry DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"ordNo":{"type":"string","description":"Order No."},"ordAccpDtm":{"type":"string","format":"date-time","description":"Order Receipt Date/Time"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"ordMediaCdNm":{"type":"string","description":"Order Channel Code Name"},"siteNm":{"type":"string","description":"Site Name"},"ordManNm":{"type":"string","description":"Member Name"},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)"},"mbrGradeCdNm":{"type":"string","description":"Member Grade Name"},"mbrMgrCd":{"type":"string","description":"Member Management Code (ME002)"},"mbrMgrCdNm":{"type":"string","description":"Member Grade Code Name"},"cashRcptYn":{"type":"string","description":"Cash Receipt Request Status"},"emailAddr":{"type":"string","description":"Email"},"cellSctNo":{"type":"string","description":"Mobile Phone Prefix Code"},"cellTxnoNo":{"type":"string","description":"Mobile Phone Exchange Code"},"cellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"},"instMbrYn":{"type":"string","description":"Interested Customer"},"instMbrGbNm":{"type":"string","description":"Interested Customer Type"},"loginId":{"type":"string","description":"Member ID"},"mbrNo":{"type":"string","description":"Member No."},"dlvCnt":{"type":"integer","format":"int32","description":"Free Shipping Coupon Count"},"cpnCnt":{"type":"integer","format":"int32","description":"Coupon Count"},"mlgAvalAmt":{"type":"integer","format":"int64","description":"Available Mileage Amount"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcOrdMbrInfo":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Order Information and Member Information","description":" ## Function Description\n * Retrieves the order information and orderer information of the order row selected from the order list.\n ---\n ## Detailed Description\n * Retrieves the order information and orderer information using the order number of the selected order row.\n * For members only, the coupon count is retrieved via the Promotion API, and the currently available mileage is retrieved via the Member API.\n","operationId":"getOrdClmProcOrdMbrInfo","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderClaimOrdMbrInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Order History
> \## Function Description\
> \* Retrieves the order list of the selected customer row after retrieving the customer list in Order Management > Order Claim Processing.\
> \---\
> \## Detailed Description\
> \* Retrieves the order list using the mbrNo and cellNo of the selected customer row as conditions.\
> \* If an order number is entered, the order list is retrieved using the order number as an additional condition.\
> \---\
> \## Revision History\
> \* Release v2.00\_240530: Changed the date inquiry query
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"RealGridListResponseOrderClaimOrdInfoListResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimOrdInfoListResponse"}}}},"OrderClaimOrdInfoListResponse":{"type":"object","description":"Order Claim Processing Order Detail List DTO","properties":{"rglrDeliNo":{"type":"string","description":"Subscription Delivery No."},"ordNo":{"type":"string","description":"Order No."},"ordManNm":{"type":"string","description":"Orderer Name"},"siteNm":{"type":"string","description":"Site Name"},"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)"},"ordMediaCdNm":{"type":"string","description":"Order Channel Code Name"},"ordGbCd":{"type":"string","description":"Order Classification Code (OM002)"},"ordGbCdNm":{"type":"string","description":"Order Classification Code Name"},"ordAccpDtm":{"type":"string","format":"date-time","description":"Order Reception Date"},"salePrc":{"type":"number","description":"Order Amount"},"dcAmt":{"type":"number","description":"Discount Amount"},"dlvryCost":{"type":"number","description":"Delivery Fee"},"totalSalePrc":{"type":"number","description":"Actual Payment Amount"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcOrdInfoList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Order History","description":" ## Function Description\n * Retrieves the order list of the selected customer row after retrieving the customer list in Order Management > Order Claim Processing.\n ---\n ## Detailed Description\n * Retrieves the order list using the mbrNo and cellNo of the selected customer row as conditions.\n * If an order number is entered, the order list is retrieved using the order number as an additional condition.\n ---\n ## Revision History\n * Release v2.00_240530: Changed the date inquiry query\n","operationId":"getOrdClmProcOrdInfoList","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"cellNo","in":"query","description":"Mobile Phone Number","schema":{"type":"String"}},{"name":"ordNo","in":"query","description":"Order No.","schema":{"type":"String"}},{"name":"mbrNo","in":"query","description":"Member No.","schema":{"type":"String"}},{"name":"ordAccpStrtDt","in":"query","description":"Order Receipt Start Date","schema":{"type":"LocalDate"}},{"name":"ordAccpEndDt","in":"query","description":"Order Receipt End Date","schema":{"type":"LocalDate"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimOrdInfoListResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Ordered Product History
> \## Function Description\
> \* Retrieves the ordered product history corresponding to the order number.\
> \---\
> \## Detailed Description\
> \* Retrieves each code corresponding to the order history status code (ref\_1\_val) and order history type code (ref\_2\_val) of the BO System Claim-Processable Status (ST008) group code, and displays the corresponding button.\
> \---\
> \## Revision History\
> \- \`\`\`release\_231009\_01\`\`\`: Modified the query due to the addition of order benefit relationship table columns (ORD\_QTY, CNCL\_QTY)\
> \- \`\`\`Release v2.00\_240729\`\`\`: Added cancellation available status (ordCnclPsbYn), collection status (wthdYn), e-coupon number (ecpnNo), e-ticket number (etcktNo)\
> \- \`\`\`Release v2.00\_240829\`\`\`: Updated masking processing
````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"RealGridListResponseOrderClaimOrdGoodsInfoResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimOrdGoodsInfoResponse"}}}},"OrderClaimOrdGoodsInfoResponse":{"type":"object","description":"Ordered Product History Inquiry DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordDtlGbCd":{"type":"string","description":"Order Detail Classification Code (OM003)"},"ordDtlGbCdNm":{"type":"string","description":"Order Detail Classification Code Name"},"ordGbCd":{"type":"string","description":"Order Classification Code (OM002)"},"ordGbCdNm":{"type":"string","description":"Order Classification Code Name"},"ordSeq":{"type":"string","description":"Order Sequence No."},"ordProcSeq":{"type":"string","description":"Order Processing Sequence No."},"claimNo":{"type":"string","description":"Claim No."},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"goodsTypCd":{"type":"string","description":"Product Type Code (PR002)"},"goodsTypCdNm":{"type":"string","description":"Product Type Code Name"},"brandNm":{"type":"string","description":"Brand Name"},"ordDtlStatCd":{"type":"string","description":"Order Detail Sub-Type Code (OM005)"},"ordDtlStatCdNm":{"type":"string","description":"Order Detail Sub-Type Code Name"},"prestNm":{"type":"string","description":"Gift Item Name"},"salePrc":{"type":"number","description":"Selling Price"},"dcAmt":{"type":"number","description":"Discount Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"rtnQty":{"type":"integer","format":"int32","description":"Return Quantity"},"ordAmt":{"type":"number","description":"Order Amount"},"deliNo":{"type":"string","description":"Delivery No."},"deliKindCd":{"type":"string","description":"Delivery Type Code (LO009)"},"deliKindCdNm":{"type":"string","description":"Delivery Type Code Name"},"shipWaitCaus":{"type":"string","description":"Shipping Hold Reason Code (LO007)"},"shipWaitCausNm":{"type":"string","description":"Shipping Hold Reason Code Name"},"shipWaitCausCont":{"type":"string","description":"Awaiting Shipment Detail Reason"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Code (PR008)"},"deliProcTypCdNm":{"type":"string","description":"Delivery Processing Type Code Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"deliAddr":{"type":"string","description":"Delivery Address"},"deliMethodCd":{"type":"string","description":"Delivery Method Code (LO010)"},"deliMethodCdNm":{"type":"string","description":"Delivery Method Code Name"},"ordAccpDtm":{"type":"string","format":"date-time","description":"Order Reception Date"},"ordFnshDtm":{"type":"string","format":"date-time","description":"Order Completion Date"},"entrNo":{"type":"string","description":"Vendor No."},"orginDeliNo":{"type":"string","description":"Original Delivery No."},"rtnDeliNo":{"type":"string","description":"Collection Delivery No."},"deliPolcNo":{"type":"string","description":"Delivery Fee Policy No."},"deliGbCd":{"type":"string","description":"Delivery Type Code (LO001)"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)"},"claimCauseFaultType":{"type":"string","description":"Claim Responsibility Type (10: Customer Responsibility / 20: Company Responsibility)"},"wthdFnshGbCd":{"type":"string","description":"Collection Completion Classification Code (LO011)"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"ordCnclPsbYn":{"type":"string","description":"Cancellation Availability Status"},"wthdYn":{"type":"string","description":"Collection Status"},"ecpnNo":{"type":"string","description":"E-Coupon No."},"rtnRejectProcSeq":{"type":"string","description":"Return Withdrawal Order Processing Sequence No."},"buttonCdList":{"type":"array","description":"Claim Button List","items":{"type":"string"}},"deliSeq":{"type":"integer","format":"int32","description":"Delivery Sequence No."},"deliDtlStatCd":{"type":"string","description":"Delivery Detail Code Name"},"deliDtlStatCdNm":{"type":"string","description":"Delivery Detail Code (LO016)"},"shipQty":{"type":"integer","format":"int32","description":"Shipment Quantity"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcOrdGoodsList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Ordered Product History","description":" ## Function Description\n * Retrieves the ordered product history corresponding to the order number.\n ---\n ## Detailed Description\n * Retrieves each code corresponding to the order history status code (ref_1_val) and order history type code (ref_2_val) of the BO System Claim-Processable Status (ST008) group code, and displays the corresponding button.\n ---\n ## Revision History\n - ```release_231009_01```: Modified the query due to the addition of order benefit relationship table columns (ORD_QTY, CNCL_QTY)\n - ```Release v2.00_240729```: Added cancellation available status (ordCnclPsbYn), collection status (wthdYn), e-coupon number (ecpnNo), e-ticket number (etcktNo)\n - ```Release v2.00_240829```: Updated masking processing\n","operationId":"getOrdClmProcOrdGoodsList","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimOrdGoodsInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Order Management > Order Claim Processing > Retrieve Accrued Mileage Detail Popup
> \## Function Description\
> \* Retrieves the mileage history list in Accrued/Accrued (Scheduled)/Cancelled status for the corresponding order when Promotion > Accrued Mileage is clicked in the Payment/Refund Information section of the Order Management > Order Claim Processing screen.\
> \---\
> \## Detailed Description\
> \* Retrieves accrual history accumulated in the benefit table upon order/claim occurrence, by claim number.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrdBaseRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"tmpOrdNo":{"type":"string"},"bsketNo":{"type":"string"},"ordMediaCd":{"type":"string"},"mbrNo":{"type":"string"},"ordManNm":{"type":"string"},"ordAccpDtm":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"},"mbrGradeCd":{"type":"string"},"mbrMgrCd":{"type":"string"},"fstOrdYn":{"type":"string"},"umemEmailAddr":{"type":"string"},"umemCellSctNo":{"type":"string"},"umemCellTxnoNo":{"type":"string"},"umemCellEndNo":{"type":"string"},"umemTelRgnNo":{"type":"string"},"umemTelTxnoNo":{"type":"string"},"umemTelEndNo":{"type":"string"},"umemZipNoSeq":{"type":"integer","format":"int32"},"umemZipNo":{"type":"string"},"umemZipAddr":{"type":"string"},"umemDtlAddr":{"type":"string"},"rfdBankCd":{"type":"string"},"rfdActnNo":{"type":"string"},"rfdActnDepositorNm":{"type":"string"},"trnsDt":{"type":"string"},"trnsTm":{"type":"string"},"ordNo":{"type":"string"},"ordRsltCd":{"type":"string"},"ordRsltMsgCont":{"type":"string"},"rtnExchgGbCd":{"type":"string"},"deilRtnGbCd":{"type":"string"},"pagingYn":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"goodsImgDomain":{"type":"string"},"condxSysRegDtmAll":{"type":"string"},"umbrNo":{"type":"string"}}},"RealGridListResponseOrderClaimMileageHistResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimMileageHistResponse"}}}},"OrderClaimMileageHistResponse":{"type":"object","properties":{"claimNo":{"type":"string","description":"Claim No."},"purchaseAmt":{"type":"integer","format":"int64","description":"Purchase Amount"},"mileage":{"type":"integer","format":"int64","description":"Mileage"},"procDtm":{"type":"string","format":"date-time","description":"Processing Date/Time"},"rsrvYn":{"type":"string","description":"Accrual Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcMileageHistList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Accrued Mileage Detail Popup","description":" ## Function Description\n * Retrieves the mileage history list in Accrued/Accrued (Scheduled)/Cancelled status for the corresponding order when Promotion > Accrued Mileage is clicked in the Payment/Refund Information section of the Order Management > Order Claim Processing screen.\n ---\n ## Detailed Description\n * Retrieves accrual history accumulated in the benefit table upon order/claim occurrence, by claim number.\n","operationId":"getOrdClmProcMileageHistList","parameters":[{"name":"ordBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrdBaseRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimMileageHistResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Customer List
> \## Function Description\
> \* Retrieves the customer list when the search button is clicked in Order Management > Order Claim Processing.\
> \---\
> \## Detailed Description\
> \* Retrieves the customer list corresponding to Member ID/Name, mobile phone number, and order number.\
> \* For non-members, no results are returned when searching by Member ID/Name.\
> \* Only customers who have placed at least one order are retrieved. Customers who have not placed an order are not retrieved.\
> \## Revision History\
> \* Release v2.00\_241120: Changed to retrieve the customer list with orders based on the member information table (previously: based on the basic order table)
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"RealGridListResponseOrderClaimMbrInfoListResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimMbrInfoListResponse"}}}},"OrderClaimMbrInfoListResponse":{"type":"object","description":"Order Claim Processing Customer List Inquiry DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"ordNo":{"type":"string","description":"Order No."},"mbrNo":{"type":"string","description":"Member No."},"loginId":{"type":"string","description":"Login ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGbCd":{"type":"string","description":"Member Classification Code (ME001)"},"mbrGbCdNm":{"type":"string","description":"Member Type Code Name"},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)"},"mbrGradeCdNm":{"type":"string","description":"Member Grade Code Name"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"},"cellSctNo":{"type":"string","description":"Mobile Phone Prefix Code"},"cellTxnoNo":{"type":"string","description":"Mobile Phone Exchange Code"},"cellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"emailAddr":{"type":"string","description":"Email Address"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"siteNm":{"type":"string","description":"Site Name"},"telNo":{"type":"string","description":"Phone Number"},"cellNo":{"type":"string","description":"Mobile Phone Number"},"mgrGbCd":{"type":"string","description":"Managed Member Type Code (ME019)"},"mgrGbCdNm":{"type":"string","description":"Managed Member Type Code Name"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcMbrInfoList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Customer List","description":" ## Function Description\n * Retrieves the customer list when the search button is clicked in Order Management > Order Claim Processing.\n ---\n ## Detailed Description\n * Retrieves the customer list corresponding to Member ID/Name, mobile phone number, and order number.\n * For non-members, no results are returned when searching by Member ID/Name.\n * Only customers who have placed at least one order are retrieved. Customers who have not placed an order are not retrieved.\n ## Revision History\n * Release v2.00_241120: Changed to retrieve the customer list with orders based on the member information table (previously: based on the basic order table)\n","operationId":"getOrdClmProcMbrInfoList","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"mbrIdNm","in":"query","description":"Member ID/Name","schema":{"type":"String"}},{"name":"cellNo","in":"query","description":"Mobile Phone Number","schema":{"type":"String"}},{"name":"ordNo","in":"query","description":"Order No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimMbrInfoListResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Product Information and Vendor Information
> \## Function Description\
> \* Retrieves the product information and product vendor information corresponding to a single order product row.\
> \---\
> \## Detailed Description\
> \* Retrieves the product information and product vendor information corresponding to a single order product row.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"GoodsEntrInfoRequest":{"type":"object","properties":{"entrNo":{"type":"string"},"itmNo":{"type":"string"},"goodsNo":{"type":"string"},"deliPolcNo":{"type":"string"}}},"OrderClaimGoodsEntrInfoResponse":{"type":"object","description":"Product Information and Vendor Information Inquiry DTO","properties":{"orderClaimEntrInfoResponses":{"type":"array","description":"Vendor Information","items":{"$ref":"#/components/schemas/OrderClaimEntrInfoResponse"}},"orderClaimGoodsInfoResponses":{"type":"array","description":"Product Information","items":{"$ref":"#/components/schemas/OrderClaimGoodsInfoResponse"}},"orderClaimEtDeliPolcInfoResponses":{"type":"array","description":"Delivery Policy Information","items":{"$ref":"#/components/schemas/OrderClaimEtDeliPolcInfoResponse"}}}},"OrderClaimEntrInfoResponse":{"type":"object","properties":{"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"entrGbCd":{"type":"string","description":"Vendor Type Code (VD001)"},"entrGbCdNm":{"type":"string","description":"Vendor Type Code Name"},"latt":{"type":"string","description":"Latitude"},"lngt":{"type":"string","description":"Longitude"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002)"},"trdStatCd":{"type":"string","description":"Transaction Status Code (VD003)"},"trdStatCdNm":{"type":"string","description":"Transaction Status Code Name"},"lgcEntrNo":{"type":"string","description":"Core System Vendor No."},"rpstmnNm":{"type":"string","description":"Representative Name"},"bmanNo":{"type":"string","description":"Business Registration No."},"corpnNo":{"type":"string","description":"Corporate Registration No."},"btyp":{"type":"string","description":"Business Type"},"bkind":{"type":"string","description":"Business Category"},"contStrtDy":{"type":"string","description":"Contract Start Date"},"contEndDy":{"type":"string","description":"Contract End Date"},"aempNm":{"type":"string","description":"Person in Charge Name"},"aempTelRgnNo":{"type":"string","description":"Contact Person's Phone Area Code"},"aempTelTxnoNo":{"type":"string","description":"Contact Person's Phone Exchange Code"},"aempTelEndNo":{"type":"string","description":"Contact Person's Phone Last Digits"},"aempCellSctNo":{"type":"string","description":"Contact Person's Mobile Phone Prefix Code"},"aempCellTxnoNo":{"type":"string","description":"Contact Person's Mobile Phone Exchange Code"},"aempCellEndNo":{"type":"string","description":"Contact Person's Mobile Phone Last Digits"},"faxRgnNo":{"type":"string","description":"Fax Area Code"},"faxTxnoNo":{"type":"string","description":"Fax Exchange Code"},"faxEndNo":{"type":"string","description":"Fax Last Digits"},"bmanKindCd":{"type":"string","description":"Business Type Code (VD004)"},"zipNoSeq":{"type":"string","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"rmkCont":{"type":"string","description":"Remarks"},"mrgnRateGbCd":{"type":"string","description":"Margin Rate Type Code (VD008)"},"mrgnRate1":{"type":"string","description":"Margin Rate 1"},"mrgnRate2":{"type":"string","description":"Margin Rate 2"}}},"OrderClaimGoodsInfoResponse":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"entrNo":{"type":"string","description":"Vendor No."},"stdCtgNo":{"type":"string","description":"Standard Category No."},"goodsCompCd":{"type":"string","description":"Product Composition Code (PR001)"},"goodsCompCdNm":{"type":"string","description":"Product Composition Code Name"},"goodsTypCd":{"type":"string","description":"Product Type Code (PR002)"},"goodsTypCdNm":{"type":"string","description":"Product Type Code Name"},"saleMethCd":{"type":"string","description":"Sales Method Code (PR003)"},"saleMethCdNm":{"type":"string","description":"Sales Method Code Name"},"brandNo":{"type":"string","description":"Brand No."},"brandNm":{"type":"string","description":"Brand Name"},"buyrAgeLmtCd":{"type":"string","description":"Purchaser Age Restriction Code (PR004)"},"dispYn":{"type":"string","description":"Display Status"},"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStatCdNm":{"type":"string","description":"Sales Status Code Name"},"saleStrDtm":{"type":"string","format":"date-time","description":"Sales Start Date/Time"},"saleEndDtm":{"type":"string","format":"date-time","description":"Sales End Date/Time"},"buyTypCd":{"type":"string","description":"Purchase Type Code (PR006)"},"taxGbCd":{"type":"string","description":"Tax/Duty-Free Classification Code (PR007)"},"stkMgrYn":{"type":"string","description":"Inventory Management Status"},"buyQtyLmtYn":{"type":"string","description":"Purchase Quantity Limit Status"},"minLmtQty":{"type":"string","description":"Minimum Limit Quantity"},"maxLmtQty":{"type":"string","description":"Maximum Limit Quantity"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code"},"deliDday":{"type":"string","description":"Delivery Lead Time"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"supPcost":{"type":"number","description":"Supply Price"},"norPrc":{"type":"number","description":"Regular Price"},"preSalePrc":{"type":"number","description":"Previous Selling Price"},"salePrc":{"type":"number","description":"Selling Price"},"mrgnRate":{"type":"number","description":"Margin Rate"},"payMeanInfo":{"type":"string","description":"Payment Method Information"},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","format":"int32","description":"Quantity"},"prestNm":{"type":"string","description":"Gift Item Name"},"rsvStrtDtm":{"type":"string","format":"date-time","description":"Reservation Start Date/Time"},"rsvEndDtm":{"type":"string","format":"date-time","description":"Reservation End Date/Time"},"fwdidcPrarDy":{"type":"string","description":"Scheduled Shipment Instruction Date"},"tsupPrc":{"type":"number"},"tsalePrc":{"type":"number"}}},"OrderClaimEtDeliPolcInfoResponse":{"type":"object","properties":{"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"entrNo":{"type":"string","description":"Vendor No."},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)"},"stdAmt":{"type":"integer","format":"int64","description":"Standard Amount"},"dlexAmt":{"type":"number","description":"Delivery Fee Amount"},"wthdRtnAmt":{"type":"number","description":"Return Pickup Fee"},"exchDlex":{"type":"integer","format":"int64","description":"Exchange Delivery Fee"},"addDlexInfoList":{"type":"array","description":"Additional Delivery Fee","items":{"$ref":"#/components/schemas/EtAddDlexInfoResponse"}},"useYn":{"type":"string","description":"Usage Status"}}},"EtAddDlexInfoResponse":{"type":"object","description":"Additional Delivery Fee Information Response","properties":{"deliRegnGrpNo":{"type":"string","description":"Delivery Area Group No."},"deliRegnGrpNm":{"type":"string","description":"Delivery Area Group Name"},"addDlexAmt":{"type":"number","description":"Additional Delivery Fee"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcGoodsEntrInfo":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Product Information and Vendor Information","description":" ## Function Description\n * Retrieves the product information and product vendor information corresponding to a single order product row.\n ---\n ## Detailed Description\n * Retrieves the product information and product vendor information corresponding to a single order product row.\n","operationId":"getOrdClmProcGoodsEntrInfo","parameters":[{"name":"goodsEntrInfoRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsEntrInfoRequest"}},{"name":"entrNo","in":"query","description":"Vendor No.","required":true,"schema":{"type":"String"}},{"name":"itmNo","in":"query","description":"Item No.","required":true,"schema":{"type":"String"}},{"name":"goodsNo","in":"query","description":"Product No.","required":true,"schema":{"type":"String"}},{"name":"deliPolcNo","in":"query","description":"Delivery Policy No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderClaimGoodsEntrInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Benefit Application History Popup
> \## Function Description\
> \* Retrieves the list of benefit history applied/cancelled for the corresponding order when the Benefit Application History button is clicked in the Payment/Refund Information section of the Order Management > Order Claim Processing screen.\
> \---\
> \## Detailed Description\
> \* Retrieves discount history accumulated in the benefit table upon order/claim occurrence, by claim number.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrdBaseRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"tmpOrdNo":{"type":"string"},"bsketNo":{"type":"string"},"ordMediaCd":{"type":"string"},"mbrNo":{"type":"string"},"ordManNm":{"type":"string"},"ordAccpDtm":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"},"mbrGradeCd":{"type":"string"},"mbrMgrCd":{"type":"string"},"fstOrdYn":{"type":"string"},"umemEmailAddr":{"type":"string"},"umemCellSctNo":{"type":"string"},"umemCellTxnoNo":{"type":"string"},"umemCellEndNo":{"type":"string"},"umemTelRgnNo":{"type":"string"},"umemTelTxnoNo":{"type":"string"},"umemTelEndNo":{"type":"string"},"umemZipNoSeq":{"type":"integer","format":"int32"},"umemZipNo":{"type":"string"},"umemZipAddr":{"type":"string"},"umemDtlAddr":{"type":"string"},"rfdBankCd":{"type":"string"},"rfdActnNo":{"type":"string"},"rfdActnDepositorNm":{"type":"string"},"trnsDt":{"type":"string"},"trnsTm":{"type":"string"},"ordNo":{"type":"string"},"ordRsltCd":{"type":"string"},"ordRsltMsgCont":{"type":"string"},"rtnExchgGbCd":{"type":"string"},"deilRtnGbCd":{"type":"string"},"pagingYn":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"goodsImgDomain":{"type":"string"},"condxSysRegDtmAll":{"type":"string"},"umbrNo":{"type":"string"}}},"RealGridListResponseOrderClaimFvrAplyHistResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimFvrAplyHistResponse"}}}},"OrderClaimFvrAplyHistResponse":{"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"adtnBassNo":{"type":"string","description":"Additional Cost Basis No."},"adtnDtlGbNm":{"type":"string","description":"Additional Cost Detail Type Code Name"},"promoNm":{"type":"string","description":"Coupon/Promotion Name"},"adtnOcurGbCd":{"type":"string","description":"Occurrence Type Code"},"useCnclDtm":{"type":"string","format":"date-time","description":"Applied/Cancelled Date and Time"},"aplyAdtnAmt":{"type":"number","description":"Applied Amount"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"claimNo":{"type":"string","description":"Claim No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcFvrAplyHistList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Benefit Application History Popup","description":" ## Function Description\n * Retrieves the list of benefit history applied/cancelled for the corresponding order when the Benefit Application History button is clicked in the Payment/Refund Information section of the Order Management > Order Claim Processing screen.\n ---\n ## Detailed Description\n * Retrieves discount history accumulated in the benefit table upon order/claim occurrence, by claim number.\n","operationId":"getOrdClmProcFvrAplyHistList","parameters":[{"name":"ordBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrdBaseRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimFvrAplyHistResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Shipping Fee Detail Popup
> \## Function Description\
> \* Retrieves the shipping fee detail history when Shipping Fee is clicked in the Payment/Refund Information section of the Order Management > Order Claim Processing screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the shipping fee detail history corresponding to the order number.\
> \* For orders that used a free shipping coupon, the coupon issuance number is also retrieved.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DeliveryDetailRequest":{"type":"object","properties":{"ordNo":{"type":"string"},"deliNo":{"type":"string"},"dlvpSeq":{"type":"string"}}},"RealGridListResponseOrderClaimDeliveryHistResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimDeliveryHistResponse"}}}},"OrderClaimDeliveryHistResponse":{"type":"object","properties":{"deliNo":{"type":"string","description":"Delivery No."},"stdAmt":{"type":"integer","format":"int64","description":"Standard Amount"},"dlexAmt":{"type":"number","description":"Delivery Fee Amount"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"entrNm":{"type":"string","description":"Vendor Name"},"dlexAmtSum":{"type":"integer","format":"int64","description":"Total Delivery Fee"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"adtnOcurGbNm":{"type":"string","description":"Cost Occurrence Type"},"dlexOcurGbNm":{"type":"string","description":"Delivery Fee Type"},"aplyAdtnAmt":{"type":"number","description":"Applied Amount"},"fvrPolcAplyVal":{"type":"integer","format":"int64","description":"Benefit Policy Applied Value"},"adtnDtlBassNo":{"type":"string","description":"Additional Cost Detail Basis No."},"claimNo":{"type":"string","description":"Claim No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcDeliveryHistList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Shipping Fee Detail Popup","description":" ## Function Description\n * Retrieves the shipping fee detail history when Shipping Fee is clicked in the Payment/Refund Information section of the Order Management > Order Claim Processing screen.\n ---\n ## Detailed Description\n * Retrieves the shipping fee detail history corresponding to the order number.\n * For orders that used a free shipping coupon, the coupon issuance number is also retrieved.\n","operationId":"getOrdClmProcDeliveryHistList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeliveryDetailRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimDeliveryHistResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Retrieve Delivery Detail and Return/Collection Information
> \## Function Description\
> \* Retrieves the delivery detail and return/collection information history corresponding to the order number.\
> \---\
> \## Detailed Description\
> \* For exchange orders, retrieves the delivery information of the shipment row of the exchange case and the return collection information of the collection row.\
> \---\
> \## Revision History\
> \* Release v2.00\_240829 : Updated masking processing
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DeliveryReturnInfoRequest":{"type":"object","properties":{"ordNo":{"type":"string"},"ordSeq":{"type":"integer","format":"int32"},"ordProcSeq":{"type":"integer","format":"int32"},"originDeliNo":{"type":"string"},"rtnDeliNo":{"type":"string"},"deliSeq":{"type":"integer","format":"int32"}}},"OrderClaimDeliveryReturnInfoResponse":{"type":"object","description":"Delivery Detail and Return/Retrieval Information Inquiry DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"string","description":"Order Sequence No."},"ordProcSeq":{"type":"string","description":"Order Processing Sequence No."},"ordDtlStatCd":{"type":"string","description":"Order Detail Status Code (OM005)"},"ordDtlStatCdNm":{"type":"string","description":"Order Detail Status Code Name"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Code (PR008)"},"deliProcTypCdNm":{"type":"string","description":"Delivery Processing Type Code Name"},"hdcCd":{"type":"string","description":"Courier Company Code (LO005)"},"hdcCdNm":{"type":"string","description":"Courier Company Name"},"invNo":{"type":"string","description":"Invoice No."},"ordManNm":{"type":"string","description":"Orderer Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"rcvmnTelRgnNo":{"type":"string","description":"Recipient's Phone Area Code"},"rcvmnTelTxnoNo":{"type":"string","description":"Recipient's Phone Exchange Code"},"rcvmnTelEndNo":{"type":"string","description":"Recipient's Phone Last Digits"},"rcvmnCellSctNo":{"type":"string","description":"Recipient's Mobile Phone Prefix Code"},"rcvmnCellTxnoNo":{"type":"string","description":"Recipient's Mobile Phone Exchange Code"},"rcvmnCellEndNo":{"type":"string","description":"Recipient's Mobile Phone Last Digits"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"deliMsg":{"type":"string","description":"Delivery Message"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"deliMsgCdNm":{"type":"string","description":"Delivery Message Code Name"},"exRtnGbCd":{"type":"string","description":"Retrieval Type Code (OM002)"},"exRtnGbCdNm":{"type":"string","description":"Retrieval Type Code Name"},"exRtnStatCd":{"type":"string","description":"Return Progress Status Code (OM005)"},"exRtnStatCdNm":{"type":"string","description":"Return Progress Status Code Name"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)"},"claimMgrpCdNm":{"type":"string","description":"Claim Subcategory Code Name"},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"rtnDeliProcTypCd":{"type":"string","description":"Retrieval Processing Type Code (PR008)"},"rtnDeliProcTypCdNm":{"type":"string","description":"Retrieval Processing Type Code Name"},"rtnHdcCd":{"type":"string","description":"Pickup Courier Code (LO005)"},"rtnHdcCdNm":{"type":"string","description":"Pickup Courier Code Name"},"rtnInvNo":{"type":"string","description":"Pickup Invoice No."},"rtnZipNo":{"type":"string","description":"Return Postal Code"},"rtnZipAddr":{"type":"string","description":"Return Postal Address"},"rtnDtlAddr":{"type":"string","description":"Return Detailed Address"},"rtnDeliMsg":{"type":"string","description":"Return Delivery Message"},"rtnDeliMsgCd":{"type":"string","description":"Return Delivery Message Code (ME039)"},"rtnDeliMsgCdNm":{"type":"string","description":"Return Delivery Message Code Name"},"wthdFnshGbCdNm":{"type":"string","description":"Retrieval Completion Type (LO011)"},"deliDtlStatCdNm":{"type":"string","description":"Delivery History Status Code Name"},"persCstmCd":{"type":"string","description":"Personal Customs Clearance Number"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmProcDeliRtnInfo":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Retrieve Delivery Detail and Return/Collection Information","description":" ## Function Description\n * Retrieves the delivery detail and return/collection information history corresponding to the order number.\n ---\n ## Detailed Description\n * For exchange orders, retrieves the delivery information of the shipment row of the exchange case and the return collection information of the collection row.\n ---\n ## Revision History\n * Release v2.00_240829 : Updated masking processing\n","operationId":"getOrdClmProcDeliRtnInfo","parameters":[{"name":"deliveryReturnInfoRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeliveryReturnInfoRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}},{"name":"ordSeq","in":"query","description":"Order Sequence No.","schema":{"type":"Integer"}},{"name":"ordProcSeq","in":"query","description":"Order Processing Sequence No.","schema":{"type":"Integer"}},{"name":"originDeliNo","in":"query","description":"Original Delivery No.","schema":{"type":"String"}},{"name":"rtnDeliNo","in":"query","description":"Collection Delivery No.","schema":{"type":"String"}},{"name":"deliSeq","in":"query","description":"Delivery Sequence No.","schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderClaimDeliveryReturnInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieves the progress status history.
> \## Function Description\
> \* Retrieves the delivery progress status history, and the return/collection progress status history.\
> \---\
> \## Detailed Description\
> \* Retrieves the delivery progress status history, and the return/collection progress status history.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrdDtlStatHistSearchRequest":{"type":"object","properties":{"ordNo":{"type":"string"},"ordSeq":{"type":"integer","format":"int32"},"deliNo":{"type":"string"},"returnTabYn":{"type":"string"},"ordDtlGbCd":{"type":"string"},"chgDtm":{"type":"string","format":"date"}}},"RealGridListResponseOrderClaimOrdDtlStatChgHistResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimOrdDtlStatChgHistResponse"}}}},"OrderClaimOrdDtlStatChgHistResponse":{"type":"object","description":"Progress Status History Inquiry DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"string","description":"Order Sequence No."},"ordDtlStatCd":{"type":"string","description":"Order Detail Status Code (OM005)"},"ordDtlStatCdNm":{"type":"string","description":"Order Detail Status Code Name"},"chgDtm":{"type":"string","format":"date-time","description":"Change Date/Time"},"ordDtlGbCd":{"type":"string","description":"Order Detail Type Code (OM002)"},"ordDtlGbCdNm":{"type":"string","description":"Order Detail Classification Code Name"},"goodsNm":{"type":"string","description":"Product Name"},"itmNm":{"type":"string","description":"Item Name"},"ordDtlChgGbCd":{"type":"string","description":"Change Type Code (OM002)"},"ordDtlChgGbCdNm":{"type":"string","description":"Change Type Code Name"},"orderClaimOrdDtlGbCdResponseList":{"type":"array","description":"Order History Type Code List","items":{"$ref":"#/components/schemas/OrderClaimOrdDtlGbCdResponse"}}}},"OrderClaimOrdDtlGbCdResponse":{"type":"object","description":"Order History Type Code List DTO","properties":{"chgDate":{"type":"string","format":"date","description":"Change Date/Time"},"ordDtlGbCd":{"type":"string","description":"Order Detail Type Code (OM002)"},"ordDtlGbCdNm":{"type":"string","description":"Order Detail Classification Code Name"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmOrdDtlStatChgHistList":{"get":{"tags":["Order Claim Processing"],"summary":"Retrieves the progress status history.","description":" ## Function Description\n * Retrieves the delivery progress status history, and the return/collection progress status history.\n ---\n ## Detailed Description\n * Retrieves the delivery progress status history, and the return/collection progress status history.\n","operationId":"getOrdClmOrdDtlStatChgHistList","parameters":[{"name":"searchRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrdDtlStatHistSearchRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}},{"name":"ordSeq","in":"query","description":"Order Sequence No.","required":true,"schema":{"type":"int"}},{"name":"deliNo","in":"query","description":"Delivery No.","required":true,"schema":{"type":"String"}},{"name":"returnTabYn","in":"query","description":"Return Collection Tab Status","required":true,"schema":{"type":"String"}},{"name":"ordDtlGbCd","in":"query","description":"Order Detail Type Code","required":true,"schema":{"type":"String"}},{"name":"chgDtm","in":"query","description":"Status Change Date/Time","schema":{"type":"LocalDate"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimOrdDtlStatChgHistResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Customer Service > Integrated Consultation Management > Consultation Registration Popup > Customer Order List Inquiry Popup
> \## Function Description\
> \- Retrieves the customer's order list from the Customer Order List Inquiry popup.\
> \---\
> \## Detailed Content\
> \- Retrieves the customer's order list corresponding to member number, order date, and product name.\
> \---\
> \## Revision History\
> \* Release v2.00\_240830: Added condition for OM003 (order history type code) 10: General Order, 30: Exchange Order
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CustomerOrderSearchRequest":{"type":"object","properties":{"mbrNo":{"type":"string"},"ordStrtDate":{"type":"string","format":"date"},"ordEndDate":{"type":"string","format":"date"},"goodsNm":{"type":"string"},"entiretyPeriodYn":{"type":"string"}}},"RealGridListResponseOrderClaimCustomerOrderResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimCustomerOrderResponse"}}}},"OrderClaimCustomerOrderResponse":{"type":"object","properties":{"ordNo":{"type":"string"},"ordSeq":{"type":"string"},"ordAccpDtm":{"type":"string","format":"date-time"},"mbrNo":{"type":"string"},"goodsNo":{"type":"string"},"goodsNm":{"type":"string"},"itmNo":{"type":"string"},"itmNm":{"type":"string"},"salePrc":{"type":"number"},"entrNo":{"type":"string"},"entrNm":{"type":"string"},"ordDtlGbCdNm":{"type":"string"},"ordDtlStatCdNm":{"type":"string"},"rcvmnNm":{"type":"string"},"rcvmnCellSctNo":{"type":"string"},"rcvmnCellTxnoNo":{"type":"string"},"rcvmnCellEndNo":{"type":"string"},"rcvmnCellNo":{"type":"string"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getOrdClmCustomerOrderList":{"get":{"tags":["Order Claim Processing"],"summary":"Customer Service > Integrated Consultation Management > Consultation Registration Popup > Customer Order List Inquiry Popup","description":" ## Function Description\n - Retrieves the customer's order list from the Customer Order List Inquiry popup.\n ---\n ## Detailed Content\n - Retrieves the customer's order list corresponding to member number, order date, and product name.\n ---\n ## Revision History\n * Release v2.00_240830: Added condition for OM003 (order history type code) 10: General Order, 30: Exchange Order\n","operationId":"getOrdClmCustomerOrderList","parameters":[{"name":"customerOrderSearchRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CustomerOrderSearchRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimCustomerOrderResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Change > Retrieves the list of changeable items (SKUs).
> \## Function Description\
> \* Retrieves the list of changeable items (SKUs).\
> \---\
> \## Detailed Description\
> \* Retrieves the list of changeable items (SKUs).
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderClaimRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"mbrNo":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"ordNo":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"}}},"ClaimItmOtherInfoListResponse":{"type":"object","description":"Order Change Item (SKU) List Inquiry DTO","properties":{"goodsNo":{"type":"string","description":"Product No."},"reqIteNo":{"type":"string","description":"Item No. to Change"},"itmNos":{"type":"array","description":"Item No. List","items":{"$ref":"#/components/schemas/ClaimItmOtherInfoResponse"}}}},"ClaimItmOtherInfoResponse":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"itmNm":{"type":"string","description":"Item Name"},"stkQty":{"type":"integer","format":"int64","description":"Remaining Quantity"},"supPcost":{"type":"number","description":"Supply Price"},"norPrc":{"type":"number","description":"Regular Price"},"salePrc":{"type":"number","description":"Selling Price"},"tsalePrc":{"type":"number","description":"Final Sale Price"},"tsupPrc":{"type":"number","description":"Final Supply Cost"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getGoodsItmInfoList":{"get":{"tags":["Order Claim Processing"],"summary":"Order Change > Retrieves the list of changeable items (SKUs).","description":" ## Function Description\n * Retrieves the list of changeable items (SKUs).\n ---\n ## Detailed Description\n * Retrieves the list of changeable items (SKUs).\n","operationId":"getGoodsItmInfoList","parameters":[{"name":"orderClaimRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClaimItmOtherInfoListResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order Management > Order Claim Processing > Delivery No. Option List within Shipping Fee Detail Popup
> \## Function Description\
> \* Retrieves all delivery numbers for the corresponding order number when the Shipping Fee Detail popup is invoked.\
> \---\
> \## Detailed Description\
> \* This is the delivery number list used for the option list in the popup screen.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrdBaseRequest":{"type":"object","properties":{"siteNo":{"type":"string"},"tmpOrdNo":{"type":"string"},"bsketNo":{"type":"string"},"ordMediaCd":{"type":"string"},"mbrNo":{"type":"string"},"ordManNm":{"type":"string"},"ordAccpDtm":{"type":"string"},"ordAccpStrtDt":{"type":"string","format":"date"},"ordAccpEndDt":{"type":"string","format":"date"},"mbrGradeCd":{"type":"string"},"mbrMgrCd":{"type":"string"},"fstOrdYn":{"type":"string"},"umemEmailAddr":{"type":"string"},"umemCellSctNo":{"type":"string"},"umemCellTxnoNo":{"type":"string"},"umemCellEndNo":{"type":"string"},"umemTelRgnNo":{"type":"string"},"umemTelTxnoNo":{"type":"string"},"umemTelEndNo":{"type":"string"},"umemZipNoSeq":{"type":"integer","format":"int32"},"umemZipNo":{"type":"string"},"umemZipAddr":{"type":"string"},"umemDtlAddr":{"type":"string"},"rfdBankCd":{"type":"string"},"rfdActnNo":{"type":"string"},"rfdActnDepositorNm":{"type":"string"},"trnsDt":{"type":"string"},"trnsTm":{"type":"string"},"ordNo":{"type":"string"},"ordRsltCd":{"type":"string"},"ordRsltMsgCont":{"type":"string"},"rtnExchgGbCd":{"type":"string"},"deilRtnGbCd":{"type":"string"},"pagingYn":{"type":"string"},"mbrIdNm":{"type":"string"},"cellNo":{"type":"string"},"goodsImgDomain":{"type":"string"},"condxSysRegDtmAll":{"type":"string"},"umbrNo":{"type":"string"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getDeliNoListByOrdNo":{"get":{"tags":["Order Claim Processing"],"summary":"Order Management > Order Claim Processing > Delivery No. Option List within Shipping Fee Detail Popup","description":" ## Function Description\n * Retrieves all delivery numbers for the corresponding order number when the Shipping Fee Detail popup is invoked.\n ---\n ## Detailed Description\n * This is the delivery number list used for the option list in the popup screen.\n","operationId":"getDeliNoListByOrdNo","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrdBaseRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Return/Exchange Reason
> \## Function Description\
> Retrieves the return/exchange reason selected by the user when receiving a return or exchange.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Retrieves based on \*\*Order No. (ordNo), Order Sequence No. (ordSeq), Order Processing Sequence No. (ordProcSeq)\*\*.\
\
\
> \* Retrieves claim information and claim major category/middle category/other reason information.\
\
\
> \* Since reason selection is a required value when receiving a return or exchange, a \*\*ValidationException\*\* occurs if there is no result value.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimCausePopupRequest":{"type":"object","description":"Claim Return/Exchange Reason Popup Request DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."}}},"ClaimCausePopupResponse":{"type":"object","description":"Claim Return/Exchange Reason Popup Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNm":{"type":"string","description":"Item Name"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimLgrpCdNm":{"type":"string","description":"Claim Major Category Code Name"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)"},"claimMgrpCdNm":{"type":"string","description":"Claim Subcategory Code Name"},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"filePath":{"type":"string","description":"File Path"},"wthdFnshWaitProcCaus":{"type":"string","description":"Retrieval Completion Pending Processing Reason"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getClaimCauseInfo":{"get":{"tags":["Order Claim Processing"],"summary":"Retrieve Return/Exchange Reason","description":"## Function Description\nRetrieves the return/exchange reason selected by the user when receiving a return or exchange.\n
\n---\n## Detailed Content\n* Retrieves based on **Order No. (ordNo), Order Sequence No. (ordSeq), Order Processing Sequence No. (ordProcSeq)**.
\n* Retrieves claim information and claim major category/middle category/other reason information.
\n* Since reason selection is a required value when receiving a return or exchange, a **ValidationException** occurs if there is no result value.\n","operationId":"getClaimCauseInfo","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ClaimCausePopupRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}},{"name":"ordSeq","in":"query","description":"Order Sequence No.","required":true,"schema":{"type":"Integer"}},{"name":"ordProcSeq","in":"query","description":"Order Processing Sequence No.","required":true,"schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ClaimCausePopupResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Return/Exchange Reason Attached Image List
> \## Function Description\
> Retrieves the list of images attached by the user when receiving a return or exchange.\
> \
\
\
> \---\
> \## Detailed Content\
> \* Retrieves based on \*\*Order No. (ordNo), Order Sequence No. (ordSeq), Order Processing Sequence No. (ordProcSeq)\*\*.\
\
\
> \* Retrieves the list of images attached and the image count information when a claim reason is selected.\
\
\
> \* Up to 5 reason images can be attached, and the result list is returned in grid Response form.\
\
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ClaimCausePopupRequest":{"type":"object","description":"Claim Return/Exchange Reason Popup Request DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."}}},"RealGridListResponseClaimCausePopupResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/ClaimCausePopupResponse"}}}},"ClaimCausePopupResponse":{"type":"object","description":"Claim Return/Exchange Reason Popup Response DTO","properties":{"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"goodsNm":{"type":"string","description":"Product Name"},"itmNm":{"type":"string","description":"Item Name"},"claimLgrpCd":{"type":"string","description":"Claim Major Classification Code (OM047)"},"claimLgrpCdNm":{"type":"string","description":"Claim Major Category Code Name"},"claimMgrpCd":{"type":"string","description":"Claim Subcategory Code (OM006)"},"claimMgrpCdNm":{"type":"string","description":"Claim Subcategory Code Name"},"claimCausEtcCont":{"type":"string","description":"Other Claim Reason Details"},"filePath":{"type":"string","description":"File Path"},"wthdFnshWaitProcCaus":{"type":"string","description":"Retrieval Completion Pending Processing Reason"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/claim/orderClaimProc/getClaimCauseAttachFileList":{"get":{"tags":["Order Claim Processing"],"summary":"Retrieve Return/Exchange Reason Attached Image List","description":"## Function Description\nRetrieves the list of images attached by the user when receiving a return or exchange.\n
\n---\n## Detailed Content\n* Retrieves based on **Order No. (ordNo), Order Sequence No. (ordSeq), Order Processing Sequence No. (ordProcSeq)**.
\n* Retrieves the list of images attached and the image count information when a claim reason is selected.
\n* Up to 5 reason images can be attached, and the result list is returned in grid Response form.
\n","operationId":"getClaimCauseAttachFileList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ClaimCausePopupRequest"}},{"name":"ordNo","in":"query","description":"Order No.","required":true,"schema":{"type":"String"}},{"name":"ordSeq","in":"query","description":"Order Sequence No.","required":true,"schema":{"type":"Integer"}},{"name":"ordProcSeq","in":"query","description":"Order Processing Sequence No.","required":true,"schema":{"type":"Integer"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseClaimCausePopupResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```