Developers
V1
V2
API & SDK

Add delivery info API

Adds delivery info for an escrow transaction.

Supported PGs
  • KG INICIS
  • NHN KCP
  • PAYJOA (Daou)
POST https://api.iamport.kr/escrows/logis/{imp_uid}

Adds delivery info for an escrow transaction.

The request body must be 2-depth JSON.

Courier codes

Parameters

Path

imp_uid*
String

iโ€™mport transaction ID

Body

sender*
Json

Sender info

receiver*
Json

Receiver info

logis*
Json

Delivery info

Responses

200: OK
Success

code * integer

Response code

0: success, Not 0: check the message

message * string

Response message

A non-zero code includes a message like โ€˜Invalid payment infoโ€™.

response(EscrowLogisAnnotation, optional)

company *string

Courier code

invoice*string

Tracking number

sent_at*integer

Sent at UNIX TIMESTAMP

applied_at*integer

Delivery info created at UNIX TIMESTAMP
400: Bad Request
Missing parameter (varies by PG) or request not supported by specified PG
 
{
  // Response
}
401: Unauthorized
Missing or invalid access token
 
{
  // Response
}
404: Not Found
No result found
 
{
  // Response
}
405: Method Not Allowed
Not a POST request
 
{
  // Response
}
409: Conflict
Delivery info already exists or request cannot be completed
 
{
  // Response
}
500: Internal Server Error
Server error
 
{
  // Response
}

Key request parameter description

sender*Json

Sender info

EscrowLogisSenderAnnotation

name (string, optional)

Sender's name (Required for: KG INICIS)

tel (string, optional)

Sender's phone (Required for: KG INICIS)

addr (string, optional)

Sender's address (Required for: KG INICIS)

postcode (string, optional)

Sender's zip code (Required for: KG INICIS)

relationship (string, optional)

Relationship with sender (Required for: PAYJOA, Example: Self)

receiver*Json

Receiver info

EscrowLogisReceiverAnnotation

name (string, optional)

Receiver's name (Required for: KG INICIS)

tel (string, optional)

Receiver's phone (Required for: KG INICIS)

addr (string, optional)

Receiver's address (Required for: KG INICIS)

postcode (string, optional)

Receiver's zip code (Required for: KG INICIS)

logis*Json

Delivery info

EscrowLogisInfoAnnotation

company (string)

Courier code

invoice (string)

Tracking number

sent_at (integer)

Sent at UNIX TIMESTAMP

receiving_at (string, optional)

Received at (Required for: PAYJOA / Example: YYYYMMDD)

address (string, optional)

Shipping address (Required for: PAYJOA)

Response

Response Model Schema

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