⌨️배송정보 단건수정 API

등록된 배송정보를 수정할 수 있습니다.

Deprecated

이 문서는 더 이상 관리되지 않습니다.

PortOne 개발자센터를 이용해주세요.

등록한 배송정보를 단건 수정합니다.

지원되는 PG사 확인하기

• KG이니시스

• NHN KCP

• 페이조아(다우)

배송정보 단건 수정

PUT https://api.iamport.kr/escrows/logis/{imp_uid}

에스크로 결제 건에 대해서 PUT /escrows/logis/{imp_uid} 로 등록된 배송정보를 수정하는 API 입니다.

2-depth의 Json으로 Request Body가 구성되어야 합니다

logis는 하위 필드가 모두 필수입니다. sender, receiver의 각 세부 항목은 PG사마다 필수 여부가 모두 다릅니다.

수정시 수정할 항목과 기존 항목이 모두 기입되어야 합니다.

Path Parameters

Name	Type	Description
imp_uid*	String	포트원 고유번호

Request Body

Name	Type	Description
sender*	json	발신자 정보
receiver*	json	수신자 정보
logis*	json	배송정보

200: OK 성공

{
    // Response
}

400: Bad Request 필수 파라미터가 누락되거나 (PG사별로 필수 여부가 다를 수 있음), 지원하는 않는 PG사인 경우

401: Unauthorized 인증 Token이 전달되지 않았거나 유효하지 않은 경우

404: Not Found 배송정보를 수정할 거래건이 존재하지 않음

405: Method Not Allowed POST요청이 아닌 경우

409: Conflict 해당거래건은 배송정보를 수정할 수 없는 경우

500: Internal Server Error 배송정보 수정 도중 오류 발생

주요 요청 파라미터 상세 설명

sender * Json

발신자 정보

EscrowLogisSenderAnnotation

name ( string, optional)

보내는분 성함(필수 : KG이니시스)

tel ( string, optional)

보내는분 전화번호(필수 : KG이니시스)

addr ( string, optional)

보내는분 주소(필수 : KG이니시스)

postcode ( string, optional)

보내는분 우편번호(필수 : KG이니시스)

relationship ( string, optional)

보내는분과의 관계(필수 : 페이조아, 예: 본인)

receiver * Json

수신자 정보

EscrowLogisReceiverAnnotation

name ( string, optional)

받는 분 성함(필수 : KG이니시스)

tel ( string, optional)

받는 분 전화번호(필수 : KG이니시스)

addr ( string, optional)

받는 분 주소(필수 : KG이니시스)

postcode ( string, optional)

받는 분 우편번호(필수 : KG이니시스)

logis * Json

배송정보

EscrowLogisInfoAnnotation

company ( string)

택배사코드

invoice ( string)

송장번호

sent_at ( integer)

발송일시 UNIX TIMESTAMP

receiving_at (string, optional)

수령일시(필수: 페이조아 / 예: YYYYMMDD)

address ( string, optional)

발송주소(필수: 페이조아)

요청 Body Sample

{
    "logis": {
        "invoice": "1728384716123",
        "company": "우체국",
        "receiving_at": "20220215",
        "address": "성수이로20길16"
    },
    "receiver": {
        "name": "홍길동"
    },
    "sender": {
        "relationship": "가족"
    }
}

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "company": "string",
    "invoice": "string",
    "sent_at": 0,
    "applied_at": 0
  }
}

Swagger Test Link

https://api.iamport.kr/#!/escrow.logis/escrow_logis_edit