商品 API 品類 API 運輸 / 訂單 API 退貨 API 換貨 API 物流資訊客服 / 諮詢

物流資訊

POST/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/returnShippingCenters2609170000

建立退貨地

# 01

簡介

建立退貨地

# 02

詳細內容

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

建立退貨地。

賣家可使用該API建立多個退貨地。

生成的退貨地會使用註冊商品時輸入的退貨地資訊。

※如果沒有物流公司合約程式碼，您可在不建立退貨地的情況下注冊商品，

但海外配送商品必須建立退貨地。 *附加指南(點擊)

路徑

POST

/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/returnShippingCenters

例子

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v5/vendors/A00012345/returnShippingCenters

請求引數

路徑引數

名稱	是否必須	型別	描述
vendorId	O	String	賣家ID 酷澎提供給賣家的固有程式碼 ex) A00012345

請求體引數

名稱	是否必須	型別	描述
vendorId	O	String	賣家ID 酷澎提供給賣家的固有程式碼 ex) A00012345
userId	O	String	使用者ID (酷澎Wing登入賬戶)
shippingPlaceName	O	String	退貨地名稱
goodsflowInfoOpenApiDto	O	Object	物流公司資訊
	deliverCode		String	物流公司程式碼程式碼含義 HYUNDAI 樂天物流 KGB Logen物流 EPOST 郵政 HANJIN 韓進物流 CJGLS CJ大韓通運 ILYANG Ilyang物流僅上述物流公司可註冊為退貨物流公司。
	deliverName		String	物流公司名稱
	contractNumber		String	物流公司合約程式碼
	contractCustomerNumber		String	賣家編號使用郵政快遞時需輸入
	vendorCreditFee05kg		Object	商品重量為5kg時的信用費(賣家信用) 商品重量為 0 *輸入費用時的注意事項請輸入與輸入物流Goodsflow物流公司的簽約金額，而不是向顧客收取的金額。如果您輸入的金額大於簽約金額，可能會按您輸入的金額支付。適用對象: vendorCreditFee05kg~returnFee20kg
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	vendorCreditFee10kg		Object	商品重量為10kg時的信用費(賣家信用) 商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	vendorCreditFee20kg		Object	商品重量為20kg時的信用費(賣家信用) 商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	vendorCashFee05kg		Object	商品重量為 5kg時的預付費用(賣家現金) 商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	vendorCashFee10kg		Object	商品重量為 10kg時的預付費用(賣家現金) 商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	vendorCashFee20kg		Object	商品重量為 20kg時的預付費用(賣家現金) 商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	consumerCashFee05kg		Object	商品重量為 5kg時的貨到付款費用(買家現金) 商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	consumerCashFee10kg		Object	商品重量為 10kg時的貨到付款費用(買家現金) 商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	consumerCashFee20kg		Object	商品重量為 20kg時的貨到付款費用(買家現金) 商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	returnFee05kg		Object	商品重量為 5kg時的退貨費商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	returnFee10kg		Object	商品重量為10kg時的退貨費商品重量為 0。
		currencyCode		String	貨幣程式碼（符合ISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
	returnFee20kg		Object	商品重量為20kg時的退貨費商品重量為 0。
		currencyCode		String	貨幣程式碼（符合IISO-4217標準），3位大寫字元
		units		Number	貨幣整數部分，64-bit
		nanos		Number	貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]
placeAddresses	O	Array	退貨地址
	addressType		String	地址名稱 JIBUN, JIBUN&ROADNAME 程式碼含義 JIBUN 地區編號 ROADNAME 道路名
	companyContactNumber		String	電話號碼 (格式需符合E.164標準)
	phoneNumber2		String	備用電話號碼(格式：也須輸入電話號碼1相同)
	returnZipCode		String	郵政編碼: 數字，最短5位數，最長6位數
	returnAddress		String	地址，最長150個字元
	returnAddressDetail		String	詳細住址，最長200個字元

請求體例子

{
"userId": "coupang20",
"vendorId": "A00012345",
"shippingPlaceName": "반품지01",
"goodsflowInfoOpenApiDto": {
"deliverCode": "CJGLS",
"contractNumber": "85500067",
"contractCustomerNumber": "",
"vendorCreditFee05kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"vendorCreditFee10kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"vendorCreditFee20kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"vendorCashFee05kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"vendorCashFee10kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"vendorCashFee20kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"consumerCashFee05kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"consumerCashFee10kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"consumerCashFee20kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"returnFee05kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"returnFee10kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"returnFee20kg": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
}
},
"placeAddresses": [
{
"addressType": "JIBUN",
"companyContactNumber": "+1(555)444-1234",
"phoneNumber2": "",
"returnZipCode": "112207",
"returnAddress": "경기도 파주시 탄현면 월롱산로",
"returnAddressDetail": "294-58"
}
]
}

返回資訊

名稱	型別	描述
code	Number	伺服器響應碼
message	String	伺服器響應訊息
data	Array	退貨地列表資料
	resultCode	String	如果程式碼 SUCCESS or FAIL
	resultMessage	String	如果資訊 (退貨地程式碼) returnCenterCode

返回資訊例子

{

"code": "200",

"message": "SUCCESS",

"data": {

"resultCode": "SUCCESS",

"resultMessage": "1100044670"

}

錯誤程式碼

HTTP狀態程式碼 (錯誤型別)	錯誤資訊	解決方案
400 (確認請求引數)	服務申請資訊已經被註冊。	請確認是否存在使用相同退貨地名稱 (shippingPlaceName) 及地址 (returnAddress, returnAddressDetail) 註冊的退貨地。不可使用相同的退貨地名稱和地址重複註冊。
400 (確認請求引數)	[發貨地重複]該地址名已被註冊。(重複地址編號: 1000*******).	請確認是否註冊過相同退貨地名稱 (shippingPlaceName) 的退貨地。退貨地不可重複註冊。
400 (重複輸入)	[發貨地重複] Duplicated request. 公司名:xxxxx	請確認是否輸入過相同的shippingPlaceName值。
500 (確認請求引數)	shipping-places create error.	請確認輸入的物流公司合同程式碼(contractNumber)數值錯誤型別。
500 (確認請求引數)	已被註冊，但無請求體要求法確認到合同。	請確認輸入的物流公司合同程式碼(contractNumber)數值錯誤型別。
500 (確認請求引數)	伺服器錯誤 (未知錯誤/新錯誤)	請確認您輸入的賣家編號(contractCustomerNumber)數值錯誤型別。僅在物流公司為郵政(EPOST)時輸入即可。
400 (確認請求引數)	Please input the correct phone number format including numbers and '-' (min 9, max 13)	請檢查companyContactNumber 或者 phoneNumber2 欄位值是否輸入正確。正確格式需符合E.164標準。
400 (確認請求引數)	Invalid vendor ID	檢視輸入的賣家ID（vendorID）錯誤型別。
400 (確認請求引數)	The vendorId in path or requestBody doesn't match the one got from api-gateway.	請確認您輸入的賣家ID(VendorId)錯誤型別。

介面名稱

UPDATE_SHIPPING_CENTER_BY_VENDOR

路徑

POST/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/returnShippingCenters

範例端點

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v5/vendors/A00012345/returnShippingCenters

# 03

Path 參數

Name	Type	Description
vendorId*	string	賣家ID 酷澎提供給賣家的固有程式碼 ex) A00012345

# 04

請求內容

請求參數

請求內容參數

Name

Type

Description

vendorId*

string

賣家ID

酷澎提供給賣家的固有程式碼

ex) A00012345

userId*

string

使用者ID (酷澎Wing登入賬戶)

shippingPlaceName*

string

退貨地名稱

goodsflowInfoOpenApiDto*

object

物流公司資訊

deliverCode

goodsflowInfoOpenApiDto.deliverCode

string

物流公司程式碼

程式碼	含義
HYUNDAI	樂天物流
KGB	Logen物流
EPOST	郵政
HANJIN	韓進物流
CJGLS	CJ大韓通運
ILYANG	Ilyang物流

僅上述物流公司可註冊為退貨物流公司。

deliverName

goodsflowInfoOpenApiDto.deliverName

string

物流公司名稱

contractNumber

goodsflowInfoOpenApiDto.contractNumber

string

物流公司合約程式碼

contractCustomerNumber

goodsflowInfoOpenApiDto.contractCustomerNumber

string

賣家編號

使用郵政快遞時需輸入

vendorCreditFee05kg

goodsflowInfoOpenApiDto.vendorCreditFee05kg

object

商品重量為5kg時的信用費(賣家信用)

商品重量為 0

*輸入費用時的注意事項

請輸入與輸入物流Goodsflow物流公司的簽約金額，而不是向顧客收取的金額。
如果您輸入的金額大於簽約金額，可能會按您輸入的金額支付。

適用對象: vendorCreditFee05kg~returnFee20kg

currencyCode

goodsflowInfoOpenApiDto.vendorCreditFee05kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.vendorCreditFee05kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.vendorCreditFee05kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

vendorCreditFee10kg

goodsflowInfoOpenApiDto.vendorCreditFee10kg

object

商品重量為10kg時的信用費(賣家信用)

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.vendorCreditFee10kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.vendorCreditFee10kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.vendorCreditFee10kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

vendorCreditFee20kg

goodsflowInfoOpenApiDto.vendorCreditFee20kg

object

商品重量為20kg時的信用費(賣家信用)

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.vendorCreditFee20kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.vendorCreditFee20kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.vendorCreditFee20kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

vendorCashFee05kg

goodsflowInfoOpenApiDto.vendorCashFee05kg

object

商品重量為 5kg時的預付費用(賣家現金)

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.vendorCashFee05kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.vendorCashFee05kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.vendorCashFee05kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

vendorCashFee10kg

goodsflowInfoOpenApiDto.vendorCashFee10kg

object

商品重量為 10kg時的預付費用(賣家現金)

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.vendorCashFee10kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.vendorCashFee10kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.vendorCashFee10kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

vendorCashFee20kg

goodsflowInfoOpenApiDto.vendorCashFee20kg

object

商品重量為 20kg時的預付費用(賣家現金)

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.vendorCashFee20kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.vendorCashFee20kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.vendorCashFee20kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

consumerCashFee05kg

goodsflowInfoOpenApiDto.consumerCashFee05kg

object

商品重量為 5kg時的貨到付款費用(買家現金)

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.consumerCashFee05kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.consumerCashFee05kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.consumerCashFee05kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

consumerCashFee10kg

goodsflowInfoOpenApiDto.consumerCashFee10kg

object

商品重量為 10kg時的貨到付款費用(買家現金)

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.consumerCashFee10kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.consumerCashFee10kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.consumerCashFee10kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

consumerCashFee20kg

goodsflowInfoOpenApiDto.consumerCashFee20kg

object

商品重量為 20kg時的貨到付款費用(買家現金)

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.consumerCashFee20kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.consumerCashFee20kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.consumerCashFee20kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

returnFee05kg

goodsflowInfoOpenApiDto.returnFee05kg

object

商品重量為 5kg時的退貨費

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.returnFee05kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.returnFee05kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.returnFee05kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

returnFee10kg

goodsflowInfoOpenApiDto.returnFee10kg

object

商品重量為10kg時的退貨費

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.returnFee10kg.currencyCode

string

貨幣程式碼（符合ISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.returnFee10kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.returnFee10kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

returnFee20kg

goodsflowInfoOpenApiDto.returnFee20kg

object

商品重量為20kg時的退貨費

商品重量為 0。

currencyCode

goodsflowInfoOpenApiDto.returnFee20kg.currencyCode

string

貨幣程式碼（符合IISO-4217標準），3位大寫字元

units

goodsflowInfoOpenApiDto.returnFee20kg.units

number

貨幣整數部分，64-bit

nanos

goodsflowInfoOpenApiDto.returnFee20kg.nanos

number

貨幣小數部分，32-bit，取值範圍 [-999999999, 999999999]

placeAddresses*

object[]

退貨地址

addressType

placeAddresses[].addressType

string

地址名稱

JIBUN, JIBUN&ROADNAME

程式碼	含義
JIBUN	地區編號
ROADNAME	道路名

companyContactNumber

placeAddresses[].companyContactNumber

string

電話號碼 (格式需符合E.164標準)

phoneNumber2

placeAddresses[].phoneNumber2

string

備用電話號碼(格式：也須輸入電話號碼1相同)

returnZipCode

placeAddresses[].returnZipCode

string

郵政編碼: 數字，最短5位數，最長6位數

returnAddress

placeAddresses[].returnAddress

string

地址，最長150個字元

returnAddressDetail

placeAddresses[].returnAddressDetail

string

詳細住址，最長200個字元

# 05

回應內容

回應訊息

Name	Type	Description
code	number	伺服器響應碼
message	string	伺服器響應訊息
data	object[]	退貨地列表資料
resultCode data[].resultCode	string	如果程式碼 SUCCESS or FAIL
resultMessage data[].resultMessage	string	如果資訊 (退貨地程式碼) returnCenterCode

# 06

錯誤碼

HTTP	代碼	訊息
400	HTTP_400	Bad Request

錯誤說明

HTTP	類型	錯誤訊息	解決方案
400	400 (確認請求引數)	服務申請資訊已經被註冊。	請確認是否存在使用相同退貨地名稱 (shippingPlaceName) 及地址 (returnAddress, returnAddressDetail) 註冊的退貨地。不可使用相同的退貨地名稱和地址重複註冊。
400	400 (確認請求引數)	[發貨地重複]該地址名已被註冊。(重複地址編號: 1000*******).	請確認是否註冊過相同退貨地名稱 (shippingPlaceName) 的退貨地。退貨地不可重複註冊。
400	400 (重複輸入)	[發貨地重複] Duplicated request. 公司名:xxxxx	請確認是否輸入過相同的shippingPlaceName值。
500	500 (確認請求引數)	shipping-places create error.	請確認輸入的物流公司合同程式碼(contractNumber)數值錯誤型別。
500	500 (確認請求引數)	已被註冊，但無請求體要求法確認到合同。	請確認輸入的物流公司合同程式碼(contractNumber)數值錯誤型別。
500	500 (確認請求引數)	伺服器錯誤 (未知錯誤/新錯誤)	請確認您輸入的賣家編號(contractCustomerNumber)數值錯誤型別。僅在物流公司為郵政(EPOST)時輸入即可。
400	400 (確認請求引數)	Please input the correct phone number format including numbers and '-' (min 9, max 13)	請檢查companyContactNumber 或者 phoneNumber2 欄位值是否輸入正確。正確格式需符合E.164標準。
400	400 (確認請求引數)	Invalid vendor ID	檢視輸入的賣家ID（vendorID）錯誤型別。
400	400 (確認請求引數)	The vendorId in path or requestBody doesn't match the one got from api-gateway.	請確認您輸入的賣家ID(VendorId)錯誤型別。