Update delivery info API
Updates delivery info for an escrow transaction.
Supported PGs
Supported PGs
- KG INICIS
- NHN KCP
- PAYJOA (Daou)
PUT https://api.iamport.kr/escrows/logis/{imp_uid} Updates delivery info for an escrow transaction.
Updates delivery info for an escrow transaction.
The request body must be 2-depth JSON.
All parameters are required. Required properties for sender and receiver JSON objects vary by PG.
All values, to be updated and maintained, must be specified.
Parameters
Path
iโmport transaction ID
Body
Sender info
Receiver info
Delivery info
Responses
200: OK Success
{
// Response
}
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 Request cannot be completed
{
// Response
}
500: Internal Server Error Server error
{
// Response
}
Key request parameter description
sender
*
Json
Sender info
EscrowLogisSenderAnnotation
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
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
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)
Request Body Sample{ "logis": { "invoice": "1728384716123", "company": "Post Office", "receiving_at": "20220215", "address": "Address" }, "receiver": { "name": "Hong Gildong" }, "sender": { "relationship": "Family" } }
Response Model Schema
Response Model Schema
{
"code": 0,
"message": "string",
"response": {
"company": "string",
"invoice": "string",
"sent_at": 0,
"applied_at": 0
}
}
Swagger Test Link