⌨ī¸Update delivery info API

Updates delivery info for an escrow transaction.

Supported PGs
  • KG INICIS

  • NHN KCP

  • PAYJOA (Daou)

Updates delivery info for an escrow transaction.

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

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.

Path Parameters

NameTypeDescription

imp_uid*

String

i'mport transaction ID

Request Body

NameTypeDescription

sender*

json

Sender info

receiver*

json

Receiver info

logis*

json

Delivery info

{
    // 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)

Request Body Sample
{
    "logis": {
        "invoice": "1728384716123",
        "company": "Post Office",
        "receiving_at": "20220215",
        "address": "Address"
    },
    "receiver": {
        "name": "Hong Gildong"
    },
    "sender": {
        "relationship": "Family"
    }
}
Response Model Schema
{
  "code": 0,
  "message": "string",
  "response": {
    "company": "string",
    "invoice": "string",
    "sent_at": 0,
    "applied_at": 0
  }
}

Last updated