coupang
GET/v2/providers/marketplace_openapi/apis/api/v2/vendor/shipping-place/outboundv1

發貨地址查詢

# 01

簡介

API 適用的买方用户區域:韓國、台灣 您可查詢已註冊的發貨地列表。 也可使用發貨地名稱和發貨地程式碼查詢已註冊的發貨地資訊。

# 02

詳細內容

API 適用的买方用户區域:韓國、台灣

您可查詢已註冊的發貨地列表。 

也可使用發貨地名稱和發貨地程式碼查詢已註冊的發貨地資訊。 

  

**查詢發貨地資訊時使用的引數** 

1.查詢所有已註冊發貨地列表時:僅輸入pageNum和pageSize即可 

2.只查詢所需的發貨地資訊時:僅輸入 placeNames 或 placeCodes即可

 

路徑

GET

/v2/providers/marketplace_openapi/apis/api/v2/vendor/shipping-place/outbound

示例

https://api-gateway.coupang.com/v2/providers/marketplace_openapi/apis/api/v2/vendor/shipping-place/outbound?pageSize=50&pageNum=1

 

https://api-gateway.coupang.com/v2/providers/marketplace_openapi/apis/api/v2/vendor/shipping-place/outbound?placeNames=상품출고지1

請求引數

查詢引數

名稱 會否必須 型別 描述
placeCodes   Long

發貨地程式碼 

建立送貨地址時,作為Response資訊顯示的值 

與 outboundShippingPlaceCode 相同 

placeNames   String

發貨地名稱 

與shippingPlaceName相同 

  

pageNum   Integer

查詢頁數 

Min = 1, Max: 返回的totalPages 值 

※ 查詢列表時,請務必輸入該數值 

pageSize   Integer

每頁最多查詢數量  

預設值=10, Max=50   

※未輸入時,預設值將處理為10  

請求體示例

 無

 

返回訊息

名稱 型別 描述
content Array 發貨地列表資料 
  outboundShippingPlaceCode Long 發貨地程式碼 
  shippingPlaceName String

發貨地名稱 

最多可輸入50個字元 

  placeAddresses Array 發貨地址 
    addressType String

地址型別 

JIBUN, ROADNAME, OVERSEA 

    countryCode String 國家程式碼(符合ISO-3166標準 ),有效長度: 2 。例如:韓國國內為“KR”, 臺灣地區為 “TW”
    companyContactNumber String 電話號碼 (格式需符合E.164標準)
    phoneNumber2 String 備用電話號碼(格式:與電話號碼相同) 
    returnZipCode String

郵政編碼: 數字 

5~6位數  

    returnAddress String 地址,最長150個字元 
    returnAddressDetail String 詳細住址,最長200個字元  
  remoteInfos Array 偏遠地區配送資訊 
    remoteInfoId Number 偏遠地區配送資訊ID  
    deliveryCode String

物流公司程式碼 

發貨地建立API- 參考物流公司程式碼

    jejuFee Object 濟州地區配送費
      currencyCode String 貨幣程式碼(符合ISO-4217標準),3位大寫字元
      units Number 貨幣整數部分,64-bit
      nanos Number 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999]
    notJeju Object 濟州地區外的配送費
      currencyCode String 貨幣程式碼(符合ISO-4217標準),3位大寫字元
      units Number 貨幣整數部分,64-bit
      nanos Number 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999]
    usable Boolean

偏遠地區配送資訊是否有效 

true or false 

  createDate String

建立日期 (符合ISO-8601標準)

格式:YYYY-MM-DD 

  usable Boolean

是否可用 

true or false 

pagination Object 分頁 
  currentPage Number

當前頁 

例) 1 

  totalPages Number

全部頁Count  

例) 1000 

  totalElements Number

全部資料Count  

例) 1000 

  countPerPage Number

每頁資料Count  

例) 10, 20, 30 

返回訊息示例

{

  "content": [

    {

      "outboundShippingPlaceCode": 1111222,

      "shippingPlaceName": "상품출고지1",

      "createDate": "2019-06-24",

      "placeAddresses": [

        {

          "addressType": "JIBUN",

          "countryCode": "KR",

          "companyContactNumber": "+1(555)444-1234",

          "phoneNumber2": "+1(555)444-1234",

          "returnZipCode": "05510",

          "returnAddress": "서울특별시 송파구 신천동",

          "returnAddressDetail": "7-30, Tower출고지"

        }

      ],

      "remoteInfos": [

        {

          "remoteInfoId": 581487,

          "deliveryCode": "DIRECT",

          "jeju": {

"currencyCode": "KRW",

"units": 5000,

"nanos": 0

},

          "notJeju": {

"currencyCode": "KRW",

"units": 2500,

"nanos": 0

},

          "usable": true

        }

      ],

      "usable": true

    }

  ],

  "pagination": {

    "currentPage": 1,

    "countPerPage": 1,

    "totalPages": 1,

    "totalElements": 1

  }

}

錯誤程式碼

HTTP狀態程式碼(錯誤型別) 錯誤資訊 解決方案
400 (確認請求引數)  (pageNum & pageSize) or placeCodes or placeNames must be provided to call this API  請確認是否輸入了(pageNum & pageSize)或placeCodes, placeNames數值。 

 

介面名稱

OUTBOUND_SHIPPING_PLACE