페이먼트월 배송등록 API

페이먼트월 PG 사 이용시 실물상품 배송등록을 수행합니다.

Deprecated

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

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

배송정보를 등록합니다.

이커머스(실물 상품) 비즈니스의 경우 페이먼트월에서 필수적으로 요구되는 배송정보 등록 API

실물상품 배송정보를 등록합니다.

POST https://api.iamport.kr/paymentwall/delivery

해당 배송등록을 누락한 경우 페이먼트월 PG사로부터 정산대금을 받지 못합니다.

Request Body

Name

Type

Description

imp_uid*

String

포트원 거래번호

merchant_uid*

String(40)

주문번호

type*

String(10)

상품구분코드

physical:실물

digital:디지털

status*

String(10)

배송상태 구분코드

order_placed

order_shipped

delivering

delivered

carrier_tracking_id

String(64)

운송장 번호

physical 주문인 경우 필수 파라미터

carrier_type

String(64)

운송사 이름

physical 주문인 경우 필수 파라미터

estimated_delivery_datetime

integer

도착예상시간

Unix timestamp

(digital 인 경우 현 시간을 기록해도 무방)

estimated_update_datetime

integer

배송상태 업데이트 예정시간

Unix timestamp sec

(digital 인 경우 지금 시간을 기록해도 무방)

reason

String(64)

사유

refundable*

String

환불가능여부

yes

no

details

String(400)

상세 사항

shipping_address_email*

String(50)

수신자 email

shipping_address_country

String(40)

수신자 국가

(physical 주문인 경우 필수 파라미터)

shipping_address_city

String(40)

수신자 시

(physical 주문인 경우 필수 파라미터)

shipping_address_zip

String(40)

수신자 우편번호

(physical 주문인 경우 필수 파라미터)

shipping_address_state

String(40)

수신자 주

미국이 아닌 경우 'N/A'로 표기

(physical 주문인 경우 필수 파라미터)

shipping_address_street

String(40)

수신자 거리명

(physical 주문인 경우 필수 파라미터)

shipping_address_phone

String(40)

수신자 전화번호

(physical 주문인 경우 필수 파라미터)

shipping_address_firstname

String(40)

수신자 이름

(physical 주문인 경우 필수 파라미터)

shipping_address_lastname

String(40)

수신자 성

(physical 주문인 경우 필수 파라미터)

code * integer

응답코드

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

message * string

응답메세지

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

response (PaymentwallDeliveryDetailAnnotation, optional):

에러 메시지를 포함하거나, 성공시 success: 1 메시지를 포함합니다.

error_code integer

이 값이 없으면 정상적인 경우, 없으면 notices를 확인해봐야 합니다

error string

에러 메시지

notices Array[string]

자세한 에러 메시지

{
    // Response
}

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "error_code": 0,
    "error": "string",
    "notices": [
      "string"
    ]
  }
}

Swagger Test Link

https://api.iamport.kr/#!/paymentwall/paymentwall_delivery

Previous해외PG 관련 API Next본인인증 관련 API

Last updated 1 year ago

Was this helpful?

실물상품 배송정보를 등록합니다.

POST https://api.iamport.kr/paymentwall/delivery

해당 배송등록을 누락한 경우 페이먼트월 PG사로부터 정산대금을 받지 못합니다.

Request Body

Name

Type

Description

imp_uid*

String

포트원 거래번호

merchant_uid*

String(40)

주문번호

type*

String(10)

상품구분코드

physical:실물

digital:디지털

status*

String(10)

배송상태 구분코드

order_placed

order_shipped

delivering

delivered

carrier_tracking_id

String(64)

운송장 번호

physical 주문인 경우 필수 파라미터

carrier_type

String(64)

운송사 이름

physical 주문인 경우 필수 파라미터

estimated_delivery_datetime

integer

도착예상시간

Unix timestamp

(digital 인 경우 현 시간을 기록해도 무방)

estimated_update_datetime

integer

배송상태 업데이트 예정시간

Unix timestamp sec

(digital 인 경우 지금 시간을 기록해도 무방)

reason

String(64)

사유

refundable*

String

환불가능여부

yes

no

details

String(400)

상세 사항

shipping_address_email*

String(50)

수신자 email

shipping_address_country

String(40)

수신자 국가

(physical 주문인 경우 필수 파라미터)

shipping_address_city

String(40)

수신자 시

(physical 주문인 경우 필수 파라미터)

shipping_address_zip

String(40)

수신자 우편번호

(physical 주문인 경우 필수 파라미터)

shipping_address_state

String(40)

수신자 주

미국이 아닌 경우 'N/A'로 표기

(physical 주문인 경우 필수 파라미터)

shipping_address_street

String(40)

수신자 거리명

(physical 주문인 경우 필수 파라미터)

shipping_address_phone

String(40)

수신자 전화번호

(physical 주문인 경우 필수 파라미터)

shipping_address_firstname

String(40)

수신자 이름

(physical 주문인 경우 필수 파라미터)

shipping_address_lastname

String(40)

수신자 성

(physical 주문인 경우 필수 파라미터)

code * integer

응답코드

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

message * string

응답메세지

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

response (PaymentwallDeliveryDetailAnnotation, optional):

에러 메시지를 포함하거나, 성공시 success: 1 메시지를 포함합니다.

error_code integer

이 값이 없으면 정상적인 경우, 없으면 notices를 확인해봐야 합니다

error string

에러 메시지

notices Array[string]

자세한 에러 메시지

{
    // Response
}

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "error_code": 0,
    "error": "string",
    "notices": [
      "string"
    ]
  }
}