⌨️배송정보 단건등록 API

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

Deprecated

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

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

에스크로 거래 배송정보를 단건 등록합니다.

지원되는 PG사 확인하기

• KG이니시스

• NHN KCP

• 페이조아(다우)

에스크로 거래 배송등록

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

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

택배사 코드표

Path Parameters

Name	Type	Description
imp_uid*	String	포트원 거래번호

Request Body

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

200: OK 성공

EscrowLogisResponse

code * integer

응답코드

0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다

message * string

응답메세지

code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response (EscrowLogisAnnotation, optional)

EscrowLogisAnnotation

company *string

택배사코드

invoice * string

송장번호

sent_at * integer

발송일시 UNIX TIMESTAMP

__

applied_at*integer

배송정보 등록일시 UNIX TIMESTAMP

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

{
    // Response
}

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

{
    // Response
}

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

{
    // Response
}

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

{
    // Response
}

409: Conflict 이미 배송정보 등록이 완료됨, 해당거래건은 배송정보를 등록할 수 없는경우

{
    // Response
}

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

{
    // Response
}

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

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)

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

응답

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_save