로그인이 필요합니다.

개발가이드(ver2.0)

발주 취소요청 개요

고객사는 취소해야 할 발주 건을 취소요청 등록할 수 있습니다.

취소요청 등록
취소요청 등록은 물류사가 허용한 취소요청 가능단계 범위에 한하여 등록가능합니다.
고객사라면 물류사에게 취소요청 가능단계를 먼저 확인합니다.
만약, 발주 진행상태가 출고요청전이라면 가능단계 설정과 상관없이 취소요청 등록과 동시에 해당 발주가 삭제*됩니다.
발주 진행상태가 출고요청 이후라면 반드시 릴리즈 ID를 입력해야합니다.
* 한 번 삭제된 발주 건은 복구되지 않으니 주의하시길 바랍니다.

취소요청 사유
취소요청 등록 시 데이터필드 cancel_reason_code로 취소사유를 선택하거나 직접입력할 수 있습니다.
노스노스는 시스템 기본값으로 1~6까지 코드를 제공하고있으며, 6을 입력하면 cancel_reason_content로 사유를 직접입력할 수 있습니다.
4.이미 발송, 5.작업중단 불가는 등록된 취소요청 건을 물류사가 승인할 경우 선택하는 코드로 해당 코드로 등록할 수 없습니다.

취소요청 히스토리
등록된 취소요청은 물류사가 처리하며, 취소요청이 승인되면 출고취소처리됩니다.
취소요청 조회 데이터필드 history_list에서 취소요청 히스토리를 조회할 수 있습니다.


노스노스 매뉴얼 : 취소요청 바로가기 ▶

지원 method

발주 취소요청 기본 Object 구조

데이터필드 자료형 설명
cancel_id integer 발주 취소 ID
member_id integer 고객사 ID
order_id integer 발주 ID
release_id integer 릴리즈 ID
cancel_status integer 취소 상태

1.취소요청, 2.취소요청 승인, 3.취소요청 반려
코드정보 cancel_status 참고

cancel_reason_no integer 취소사유코드
cancel_reason_content string(500) 취소사유(직접입력)
history_list childDataObject history_list_object 구성 ▶

history_list_object 구조

데이터필드 자료형 설명
cancel_status integer 취소요청상태
cancel_reason_no integer 취소사유코드
create_date string(20) 등록일자
cancel_reason_content string(500) 취소사유

발주 취소요청 등록

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

Request Param

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

물류사 권한인 경우 필수

order_id integer 발주 ID

필수, 발주 진행상태가 출고요청전이라면 자동으로 발주삭제 처리

release_id integer 릴리즈 ID

발주 진행상태가 출고요청 이후인 경우 필수

cancel_reason_no integer 취소사유코드

필수
1.고객 주문 취소, 2.오발주, 3.재발주예정, 4.이미 발송, 6.기타-사유 직접입력
코드정보 cancel_reason_code 참고

cancel_reason_content string(500) 취소사유(직접입력)

취소사유코드가 6인 경우에만 입력 가능

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response cancel_id integer 발주 취소 ID

Request Sample

{
   "member_id":70,
   "order_id":"184460",
   "release_id":"53554",
   "cancel_reason_no":"6",
   "cancel_reason_content":"API로 취소"
}

Response Sample

{
    "code": "9999",
    "message": "ok",
    "response": {
        "cancel_id": "208"
    }
}

출고요청 이전인 경우 - {"code":"9999","message":"ok"}

발주 취소요청 조회(단일)

Request URI /v2/request/order_cancel/{릴리즈ID}
Method GET
권한 고객사, 물류사

Response Param

데이터필드 자료형 설명
code string(4) 응답코드
message string(100) 응답메시지
response dataObject 발주 취소요청 기본 Object 구성 ▶

Request Sample

/v2/request/order_cancel/54433

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
    "cancel_id": "402",
    "member_id": "70",
    "order_id": "193395",
    "release_id": "59133",
    "cancel_status": "3",
    "cancel_reason_no": "6",
    "cancel_reason_content": "bbb",
    "history_list": [
      {
        "cancel_status": "1",
        "cancel_reason_no": "6",
        "create_date": "2022-04-07 11:07:50",
        "cancel_reason_content": "취소 요청"
      },
      {
        "cancel_status": "3",
        "cancel_reason_no": "6",
        "create_date": "2022-04-07 11:08:55",
        "cancel_reason_content": "승인요청 반려"
      }
    ]
  }
}

발주 취소요청 조회(벌크)

Request URI /v2/request/order_cancels
Method GET
권한 고객사, 물류사

Request Param

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

물류사 권한인 경우 필수

cancel_ids array 발주취소 ID 배열

최대 100개

cancel_status integer 취소요청상태

1. 취소요청, 2. 취소요청 승인, 3. 취소요청 반려
코드정보 cancel_status 참고

order_id integer 발주 ID
release_ids array 출고요청 ID 배열
reg_date string(10) 요청일

YYYYMMDD 형식

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

1.
/v2/request/order_cancels?member_id=&cancel_status=1&cancel_ids=304&cancel_ids=303&cancel_ids=302&cancel_ids=293&page=1

2.
/v2/request/order_cancels?member_id=®_date=20220228&release_ids=59133&release_ids=58397&cancel_status=1&cancel_ids=304&cancel_ids=303

Response Sample

{
  "code": "9999",
  "message": "ok",
  "response": {
    "total_count": 3,
    "total_page": 1,
    "current_page": 1,
    "data_list": [
      {
        "cancel_id": "370",
        "member_id": "70",
        "order_id": "189435",
        "release_id": "56559",
        "cancel_status": "2",
        "cancel_reason_no": "5",
        "cancel_reason_content": "작업중단 불가",
        "history_list": [
          {
            "cancel_status": "1",
            "cancel_reason_no": "3",
            "create_date": "2022-02-28 15:31:42",
            "cancel_reason_content": "재발주예정"
          },
          {
            "cancel_status": "3",
            "cancel_reason_no": "5",
            "create_date": "2022-03-04 09:01:52",
            "cancel_reason_content": "작업중단 불가"
          }
        ]
      },
      {
        "cancel_id": "369",
        "member_id": "70",
        "order_id": "189434",
        "release_id": "56558",
        "cancel_status": "2",
        "cancel_reason_no": "5",
        "cancel_reason_content": "작업중단 불가",
        "history_list": [
          {
            "cancel_status": "1",
            "cancel_reason_no": "2",
            "create_date": "2022-02-28 15:31:39",
            "cancel_reason_content": "오발주"
          }
        ]
      },
      {
        "cancel_id": "368",
        "member_id": "70",
        "order_id": "189431",
        "release_id": "56556",
        "cancel_status": "3",
        "cancel_reason_no": "5",
        "cancel_reason_content": "작업중단 불가",
        "history_list": [
          {
            "cancel_status": "3",
            "cancel_reason_no": "5",
            "create_date": "2022-03-04 09:01:52",
            "cancel_reason_content": "작업중단 불가"
          }
        ]
      }
    ]
  }
}
Top