로그인이 필요합니다.

개발가이드(ver2.0)

반품 개요

반품을 등록/취소하거나 등록된 반품 건을 조회할 수 있습니다.

반품 등록
출고완료 된 출고 건을 반품 등록하거나 신규로 반품 등록할 수 있습니다.
출고완료 된 출고 건을 반품 등록할 경우 데이터필드 release_id에 해당 값을 입력하여 반품 등록합니다.
출고완료 한 상품에 상관없이 새로운 상품을 추가하거나 기존 상품을 삭제하고 등록할 수 있습니다.

반품 취소
등록된 반품 건을 취소할 수 있습니다.
반품 진행상태가 반품요청, 반품진행중인 경우에만 가능하며, 반품요청 취소와는 별개입니다.

노스노스 매뉴얼 : 반품요청 바로가기 ▶, 반품조회 바로가기 ▶

지원 method

반품 기본 Object 구조

데이터필드 자료형 설명
release_return_info_id integer 반품 ID
member_id integer 고객사 ID
release_id integer 릴리즈 ID
return_status titnyint 반품 진행상태

1.반품요청, 3.반품진행중, 5.반품입고완료, 9.반품취소
코드정보 return_status_code 참고

return_code string(20) 반품코드
request_date DATETIME 반품요청일

YYYY-MM-DD HH24:MI:SS 형식

request_dt string(8) 반품요청일

YYYYMMDD 형식

request_member_id integer 반품요청자 member_Id

API로 반품 등록한 경우 0으로 고정

complete_date string(8) 반품입고완료일

YYYY-MM-DD HH24:MI:SS 형식

complete_dt DATETIME 반품입고완료일

YYYYMMDD 형식

complete_member_id integer 반품입고완료자 member_id
return_reason_id integer 반품사유 ID

반품사유 조회(벌크) 참고

memo string(255) 특이사항

가장 최근 입력된 특이사항

memo_list childDataObject memo_list_object 구성 ▶

특이사항 리스트

receiving_name string(100) 회수지 보내는 분 이름
return_address1 string(100) 회수지 주소1
return_address2 string(100) 회수지 주소2
zipcode string(20) 회수지 우편번호
tel1 string(20) 회수지 전화번호1
tel2 string(20) 회수지 전화번호2
return_process_type integer 반품접수 타입

0.수동, 1.자동

delivery_agency_id integer 택배사 ID

택배사 조회(벌크) 참고

return_shipping_code string(50) 반송장번호
return_item_list childDataObject return_item_object 구성 ▶

return_item_object 구조

데이터필드 자료형 설명
release_return_item_renual_id integer 반품상품 ID

조회시만 출력

release_item_id integer 출고 ID

release_id 가 있을 경우 release_item_id과 shipping_product_id 값에 데이터 검증 필요

shipping_product_id integer 출고상품 ID

필수

quantity integer 요청수량

필수

unusable_quantity integer 폐기수량

조회시만 출력

receiving_quantity integer 입고수량

조회시만 출력

expire_date string(8) 입고 유통기한

조회시만 출력, YYYYMMDD 형식

disposal_expire_date string(8) 폐기 유동기한

조회시만 출력, YYYYMMDD 형식

memo_list_object 구조

데이터필드 자료형 설명
memo string(250) 특이사항 메모
create_dt string(20) 특이사항 등록일

YYYY-MM-DD HH24:MI:SS 형식

반품 등록(단일)

Request URI /v2/release_return/request
Method POST
권한 물류사, 고객사

Request Param

데이터필드 자료형 설명
member_id integer 고객사 ID

물류사 권한인 경우 필수

release_id integer 릴리즈 ID
return_reason_id integer 반품사유 ID

반품사유 조회(벌크) 참고

memo string(255) 특이사항
receiving_name string(100) 회수지 보내는 분 이름
return_address1 string(100) 회수지 주소1
return_address2 string(100) 회수지 주소2
zipcode string(20) 회수지 우편번호
tel1 string(20) 회수지 전화번호1
tel2 string(20) 회수지 전화번호2
return_item_list childDataObject return_item_object 구성 ▶

필수

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response release_return_info_id integer 반품 ID
return_code string(20) 반품코드

Request Sample

{
  "member_id": 70,
  "release_id": "50486",
  "return_reason_id": 3,
  "memo": "특이사항 추가-001",
  "receiving_name": "정보배2",
  "return_address1": "서울시 용산구 한남동",
  "return_address2": "비버리힐스 351 ",
  "zipcode": "087-789",
  "tel1": " 02-123-41234",
  "tel2": " 02-456-789",
  "return_item_list": [
    {
      "release_item_id": 92781,
      "shipping_product_id": 41675,
      "quantity": 2
    },
    {
      "release_item_id": "",
      "shipping_product_id": 41672,
      "quantity": 3
    }
  ]
}

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
  "release_return_info_id": "459",
  "return_code": "B20211210-00022"
  }
 }

반품 조회(단일)

Request URI /v2/release_return/{반품ID}
Method GET
권한 물류사, 고객사

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response total_count integer 전체 갯수
total_page integer 전체 페이지수
current_page integer 현재 페이지 번호
response dataObject 반품 기본 Object 구성 ▶

Request Sample

/v2/release_return/42

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
    "release_return_info_id": "708",
    "member_id": "70",
    "release_id": "",
    "return_status": "5",
    "return_code": "B20220224-00002",
    "request_date": "2022-02-24 10:44:31",
    "request_dt": "20220224",
    "request_member_id": "67",
    "complete_date": "2022-05-10 14:46:50",
    "complete_dt": "20220510",
    "complete_member_id": "67",
    "return_reason_id": "3",
    "receiving_name": "도우너",
    "return_address1": "서울 강서구 공항대로 168 (마곡동, 747)",
    "return_address2": "1207호",
    "zipcode": "07807",
    "tel1": "01011112222",
    "tel2": "",
    "return_process_type": "",
    "delivery_agency_id": "4",
    "return_shipping_code": "77777",
    "memo": "주문 외 반품등록",
    "memo_list": [
      {
        "memo": "주문 외 반품등록",
        "create_dt": "2022-02-24 10:44:31"
      },
      {
        "memo": "[사유] 지연배송",
        "create_dt": "2022-02-24 10:44:31"
      }
    ],
    "return_item_list": [
      {
        "release_return_item_renual_id": "1971",
        "release_item_id": "",
        "shipping_product_id": "43795",
        "quantity": "1",
        "unusable_quantity": "0",
        "receiving_quantity": "2",
        "expire_date": "20220531",
        "disposal_expire_date": ""
      },
      {
        "release_return_item_renual_id": "134",
        "release_item_id": "7705",
        "shipping_product_id": "10243",
        "quantity": "3",
        "unusable_quantity": "0",
        "receiving_quantity": "3",
        "expire_date": "20211130",
        "disposal_expire_date": ""
      }
    ]
  }
}

반품 조회(벌크)

Request URI /v2/release_return/searchs
Method GET
권한 물류사, 고객사

Request Param

데이터필드 자료형 설명
member_id integer 고객사 ID

물류사 권한인 경우 필수

release_return_info_ids integer 반품 ID
start_request_dt string(8) 반품 요청 시작일

YYYYMMDD 형식

end_request_dt string(8) 반품 요청 종료일

YYYYMMDD 형식

start_complete_dt string(8) 반품 입고 완료 시작일

YYYYMMDD 형식

end_complete_dt string(8) 반품 입고 완료 종료일

YYYYMMDD 형식

return_status integer 반품 진행상태

1.반품요청, 3.반품진행중, 5.반품입고완료, 9.반품취소
코드정보 return_status_code 참고

page integer 페이지번호

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response total_count integer 전체 갯수
total_page integer 전체 페이지수
current_page integer 현재 페이지 번호
data_list

처리 데이터 리스트

dataList 반품 기본 Object 구성 ▶

Request Sample

/v2/release_return/searchs?member_id=70&page=1
/v2/release_return/searchs?member_id=70&release_return_info_ids=793&release_return_info_ids=794&start_request_dt=20220410&end_request_dt=20220425&return_status=1&start_complete_dt=20220501

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
    "total_count": 4,
    "total_page": 1,
    "current_page": 1,
    "data_list": [
      {
        "release_return_info_id": "731",
        "member_id": "70",
        "release_id": "54436",
        "return_status": "5",
        "return_code": "B20220307-00002",
        "request_date": "2022-03-07 17:11:00",
        "request_dt": "20220307",
        "request_member_id": "88",
        "complete_date": "2022-05-04 14:17:32",
        "complete_dt": "20220504",
        "complete_member_id": "67",
        "return_reason_id": "3",
        "receiving_name": "홍길동",
        "return_address1": "경기 성남시 분당구 삼평동 681",
        "return_address2": "1층",
        "zipcode": "13494",
        "tel1": "01023545555",
        "tel2": "01066668888",
        "return_process_type": "0",
        "delivery_agency_id": "1",
        "return_shipping_code": "12345",
        "memo": "[사유] 지연배송",
        "memo_list": [
          {
            "memo": "[사유] 지연배송",
            "create_dt": "2022-03-07 17:11:00"
          }
        ],
        "return_item_list": [
          {
            "release_return_item_renual_id": "2005",
            "release_item_id": "103741",
            "shipping_product_id": "41668",
            "quantity": "1",
            "unusable_quantity": "0",
            "receiving_quantity": "1",
            "expire_date": "20220530",
            "disposal_expire_date": ""
          },
          {
            "release_return_item_renual_id": "2006",
            "release_item_id": "103741",
            "shipping_product_id": "41667",
            "quantity": "1",
            "unusable_quantity": "0",
            "receiving_quantity": "1",
            "expire_date": "20220531",
            "disposal_expire_date": ""
          },
          {
            "release_return_item_renual_id": "2238",
            "release_item_id": "103741",
            "shipping_product_id": "41668",
            "quantity": "1",
            "unusable_quantity": "0",
            "receiving_quantity": "2",
            "expire_date": "20220531",
            "disposal_expire_date": ""
          }
        ]
      },
      {
        "release_return_info_id": "708",
        "member_id": "70",
        "release_id": "",
        "return_status": "5",
        "return_code": "B20220224-00002",
        "request_date": "2022-02-24 10:44:31",
        "request_dt": "20220224",
        "request_member_id": "67",
        "complete_date": "2022-05-10 14:46:50",
        "complete_dt": "20220510",
        "complete_member_id": "67",
        "return_reason_id": "3",
        "receiving_name": "도우너",
        "return_address1": "서울 강서구 공항대로 168 (마곡동, 747)",
        "return_address2": "1207호",
        "zipcode": "07807",
        "tel1": "01011112222",
        "tel2": "",
        "return_process_type": "",
        "delivery_agency_id": "4",
        "return_shipping_code": "77777",
        "memo": "주문 외 반품등록",
        "memo_list": [
          {
            "memo": "주문 외 반품등록",
            "create_dt": "2022-02-24 10:44:31"
          },
          {
            "memo": "[사유] 지연배송",
            "create_dt": "2022-02-24 10:44:31"
          }
        ],
        "return_item_list": [
          {
            "release_return_item_renual_id": "1971",
            "release_item_id": "",
            "shipping_product_id": "43795",
            "quantity": "1",
            "unusable_quantity": "0",
            "receiving_quantity": "2",
            "expire_date": "20220531",
            "disposal_expire_date": ""
          }
        ]
      }
    ]
  }
}

반품 취소

Request URI /v2/release_return/{반품ID}
Method PATCH
권한 물류사, 고객사
비고 반품 진행상태가 반품요청, 반품진행중인 경우에만 가능

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지

Request Sample

/v2/release_return/435

Response Sample

{
  "code": "9999",
  "message": "ok"
}

반품사유 조회(벌크)

Request URI /v2/release_return/reason
Method GET
권한 물류사, 고객사

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response total_count integer 전체 갯수
total_page integer 전체 페이지수
current_page integer 현재 페이지 번호
data_list

처리 데이터 리스트

return_reason_id integer 반품사유 ID
return_reason string(100) 반품사유

Request Sample

/v2/release_return/reason

Response Sample

{
    "code": "9999",
    "message": "ok",
    "response": {
        "total_count": 6,
        "total_page": 1,
        "current_page": 1,
        "data_list": [
            {
                "return_reason_id": 1,
                "return_reason": "오배송(물류사귀책)"
            },
            {
                "return_reason_id": 2,
                "return_reason": "오배송(고객사귀책)"
            },
            {
                "return_reason_id": 3,
                "return_reason": "지연배송"
            },
            {
                "return_reason_id": 4,
                "return_reason": "고객변심"
            },
            {
                "return_reason_id": 5,
                "return_reason": "품질불량"
            },
            {
                "return_reason_id": 6,
                "return_reason": "상품파손"
            }
        ]
    }
}

반품 특이사항 등록(단일)

Request URI /v2/release_return/memo
Method POST
권한 물류사, 고객사
비고 반품 특이사항만 별도 등록 가능

Request Param

데이터필드 자료형 설명
member_id integer 고객사 ID

물류사 권한인 경우 필수

release_return_info_id integer 반품 ID

필수

memo string(255) 특이사항

필수

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response release_return_info_id integer 반품 ID
return_code string(20) 반품코드

Request Sample

{
  "member_id": 70,
  "release_return_info_id": 4458,
  "memo": "특이사항 추가-001"
}

Response Sample

{
  "code": "9999",
  "message": "ok"
 }
Top