배송 기준 정보

배송지역그룹 관리 등록/수정/삭제

post

기능설명

• 배송지역그룹을 등록 / 수정 / 삭제하는 API 입니다.

---

상세설명

• [BO] 배송 > 배송기준정보 관리 > 배송지역그룹 관리페이지에서 신규 등록 / 수정 / 삭제 시 호출되는 API 입니다.

• 요청 배송지역그룹정보(배송그룹지역명, 정렬순서, 사용여부, 배송지역그룹설명)을 등록 / 수정 / 삭제 합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

배송지역그룹 관리 목록 등록/수정/삭제 성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/delivery/deliveryStandardInfoMgmt/saveDeliveryRegionGroup

HTTPcURLJavaScriptPython

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

{
  "all": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "deliRegnGrpNm": "추가배송비",
      "sortSeq": 1,
      "useYn": "Y",
      "deliRegnDesc": "도서산간지역"
    }
  ],
  "create": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "deliRegnGrpNm": "추가배송비",
      "sortSeq": 1,
      "useYn": "Y",
      "deliRegnDesc": "도서산간지역"
    }
  ],
  "update": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "deliRegnGrpNm": "추가배송비",
      "sortSeq": 1,
      "useYn": "Y",
      "deliRegnDesc": "도서산간지역"
    }
  ],
  "delete": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "deliRegnGrpNm": "추가배송비",
      "sortSeq": 1,
      "useYn": "Y",
      "deliRegnDesc": "도서산간지역"
    }
  ]
}

text

배송지역관리 등록/삭제

post

기능설명

• 배송지역그룹별 배송지역을 등록 / 삭제하는 API 입니다.

---

상세설명

• [BO] 배송 > 배송기준정보 관리 > 배송지역 관리페이지에서 배송지역그룹별 배송지역을 신규 등록 / 삭제 시 호출되는 API 입니다.

• 요청 배송지역그룹번호(deliRegnGrpNo)에 배송지역정보(우편번호, 주소)를 신규 등록하거나 기 등록되어 있는 배송지역정보를 삭제합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

배송지역관리 목록 등록/수정/삭제 성공

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

업무처리 오류 내용

*/*

post

/v1/delivery/deliveryStandardInfoMgmt/saveDeliveryRegionByZipCd

HTTPcURLJavaScriptPython

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

{
  "all": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "zipNo": 63000,
      "zipAddr": "제주특별자치도 제주시 추자면 대서1길",
      "regnGbCd": "text",
      "regnGbNm": "서울특별시",
      "searchWord": "강북구"
    }
  ],
  "create": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "zipNo": 63000,
      "zipAddr": "제주특별자치도 제주시 추자면 대서1길",
      "regnGbCd": "text",
      "regnGbNm": "서울특별시",
      "searchWord": "강북구"
    }
  ],
  "update": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "zipNo": 63000,
      "zipAddr": "제주특별자치도 제주시 추자면 대서1길",
      "regnGbCd": "text",
      "regnGbNm": "서울특별시",
      "searchWord": "강북구"
    }
  ],
  "delete": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "zipNo": 63000,
      "zipAddr": "제주특별자치도 제주시 추자면 대서1길",
      "regnGbCd": "text",
      "regnGbNm": "서울특별시",
      "searchWord": "강북구"
    }
  ]
}

{
  "timestamp": "2026-02-27T18:20:38.849Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

시도명 목록 조회

get

기능설명

• 시도명 목록을 조회합니다.

---

상세설명

• [BO] 배송 > 배송기준정보 관리 > 배송지역관리 페이지에서 배송지역선택 시도명 전체 목록을 조회한다.

  • 서울특별시, 경상남도, 경상북도 등

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

배송지역관리 시도명 전체 목록 조회 성공

*/*

string[]Optional

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryStandardInfoMgmt/getRegionGroupList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryStandardInfoMgmt/getRegionGroupList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

우편번호 및 우편주소 조회

get

기능설명

• 우편번호와 주소를 조회합니다.

---

상세설명

• [BO] 배송 > 배송기준정보 관리 > 배송지역관리 페이지 배송지역그룹번호에 따른 우편번호와 우편주소를 조회합니다.

• 검색어(searchWord)를 이용해 시군구명, 읍면명, 도로명을 검색합니다.

• 배송지역그룹번호(deliRegnGrpNo)에 기등록된 우편번호를 제외하고 조회됩니다.

---

특이사항

• 우편번호는 하나의 배송지역그룹번호(deliRegnGrpNo)에만 매핑이 가능합니다.

• 배송지역그룹의 사용여부(useYn)와 관계없이 우편번호 기등록 여부를 확인합니다.

---

수정번호

• Release v2.00_240711: 추가 배송비 개선에 따라, 조회 시 배송지역그룹에 기등록된 우편번호 조회 제외 처리

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

deliRegnGrpNoStringRequired

배송지역그룹번호

regnGbNmStringOptional

지역구분명

searchWordStringOptional

검색어

Responses

200

우편번호 및 우편주소 조회 성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryStandardInfoMgmt/getDeliveryRegionPostNoList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryStandardInfoMgmt/getDeliveryRegionPostNoList?request=[object+Object]&deliRegnGrpNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "deliRegnGrpNo": 1,
      "zipNo": 123,
      "zipAddr": "서울시 송파구"
    }
  ]
}

배송지역그룹 목록 조회

get

기능설명

• 배송지역그룹 목록을 조회합니다.

---

상세설명

• 배송지역그룹 목록을 조회한다.

  • [BO] 협력사 관리 > 배송비 관리 화면에서 사용한다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

useYnStringOptional

사용여부

Responses

200

배송지역그룹 관리 목록 조회 성공

*/*

배송지역그룹 응답 DTO

deliRegnGrpNostringOptional

배송지역그룹번호

Example: 1

deliGrpGbCdstringOptional

배송그룹구분코드(LO015)

Example: 10

deliGrpGbCdNmstringOptional

배송그룹구분코드명

Example: 추가배송비

deliRegnGrpNmstringOptional

배송지역그룹명

Example: 도서산간지역

sortSeqinteger · int32Optional

정렬순서

Example: 1

useYnstringOptional

사용여부

Example: Y

deliRegnDescstringOptional

배송지역그룹설명

Example: 도서산간지역

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryStandardInfoMgmt/getDeliveryRegionGroupQueryList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryStandardInfoMgmt/getDeliveryRegionGroupQueryList?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "deliRegnGrpNo": 1,
    "deliGrpGbCd": 10,
    "deliGrpGbCdNm": "추가배송비",
    "deliRegnGrpNm": "도서산간지역",
    "sortSeq": 1,
    "useYn": "Y",
    "deliRegnDesc": "도서산간지역"
  }
]

배송지역그룹 관리 목록

get

기능 설명

• 배송지역그룹 목록과 상세정보를 조회하는 API 입니다.

---

상세 설명

• [BO] 배송 > 배송기준정보 관리 > 배송지역그룹 관리페이지에서 조회 버튼 클릭 시 호출되는 API 입니다.

• 배송지역그룹구분(LO015)과 배송지역그룹명, 사용여부를 이용해 배송지역그룹목록을 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

deliGrpGbCdStringOptional

배송그룹구분코드(LO015)

deliRegnGrpNmStringOptional

배송지역그룹명

useYnStringOptional

사용여부

Responses

200

배송지역그룹 관리 목록 조회 성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryStandardInfoMgmt/getDeliveryRegionGroupMgmtList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryStandardInfoMgmt/getDeliveryRegionGroupMgmtList?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "deliRegnGrpNo": 1,
      "deliGrpGbCd": 10,
      "deliGrpGbCdNm": "추가배송비",
      "deliRegnGrpNm": "도서산간지역",
      "sortSeq": 1,
      "useYn": "Y",
      "deliRegnDesc": "도서산간지역"
    }
  ]
}

배송지역 적용목록 조회

get

기능설명

• 배송지역그룹에 적용된 목록을 조회합니다.

---

상세설명

• [BO] 배송 > 배송기준정보 관리 > 배송지역관리 페이지 배송지역적용 목록을 조회합니다.

• 요청 배송지역그룹번호(deliRegnGrpNo)에 매핑된 우편번호, 주소 목록을 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

deliRegnGrpNoStringRequired

배송지역그룹번호

Responses

200

배송지역 적용목록 조회 성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v1/delivery/deliveryStandardInfoMgmt/getDeliRegnByZipCdList

HTTPcURLJavaScriptPython

GET /api/bo/v1/delivery/deliveryStandardInfoMgmt/getDeliRegnByZipCdList?request=[object+Object]&deliRegnGrpNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "deliRegnGrpNo": 1,
      "zipNo": 123,
      "zipAddr": "서울시 송파구"
    }
  ]
}