Skip to content

Latest commit

 

History

History
258 lines (183 loc) · 6.14 KB

add-delivery-info-api.mdx

File metadata and controls

258 lines (183 loc) · 6.14 KB
Raw
title description
Add delivery info API

import Details from "/components/gitbook/Details.astro"; import Swagger from "/components/gitbook/swagger/Swagger.astro"; import SwaggerDescription from "/components/gitbook/swagger/SwaggerDescription.astro"; import SwaggerParameter from "/components/gitbook/swagger/SwaggerParameter.astro"; import SwaggerResponse from "/components/gitbook/swagger/SwaggerResponse.astro"; import Tab from "/components/gitbook/tabs/Tab.astro"; import Tabs from "/components/gitbook/tabs/Tabs.astro"; import Hint from "/components/Hint.astro";

Adds delivery info for an escrow transaction.

Supported PGs

  • KG INICIS
  • NHN KCP
  • PAYJOA (Daou)
The request body must be **2-depth JSON**. 
[**Courier codes**](../../tips/code)

Parameters

Path

**i'mport transaction ID**

Body

**Sender info** **Receiver info** **Delivery info**

Responses

**`code`** **\*** **integer** 
    **Response code**

    0: success, Not 0: check the message

    **`message`** <mark style="color:red;">**\***</mark> <mark style="color:green;">**string**</mark>

    **Response message**

    A non-zero code includes a message like 'Invalid payment info'.

    **`response`**<mark style="color:red;">**`(EscrowLogisAnnotation, optional)`**</mark>
  </Tab>
</Tabs>

<Tabs>
  <Tab title="EscrowLogisAnnotation">
    **`company`** <mark style="color:red;">**`*`**</mark><mark style="color:green;">**`string`**</mark>

    **`Courier code`**

    **`invoice`**<mark style="color:red;">**`*`**</mark><mark style="color:green;">**`string`**</mark>

    **`Tracking number`**

    **`sent_at`**<mark style="color:red;">**`*`**</mark><mark style="color:orange;">**`integer`**</mark>

    **`Sent at`** _**UNIX TIMESTAMP**_

    **`applied_at`**_<mark style="color:red;">**`*`**</mark>_<mark style="color:orange;">**`integer`**</mark>

    **`Delivery info created at`** _**UNIX TIMESTAMP**_
  </Tab>
</Tabs>
```ts { // Response } ``` ```ts { // Response } ``` ```ts { // Response } ``` ```ts { // Response } ``` ```ts { // Response } ``` ```ts { // 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
  }
}
**Swagger Test Link**

https://api.iamport.kr/#!/escrow.logis/escrow_logis_save