Products Categories Brands Shipments & Orders Returns Exchanges Promotions & Coupons Logistics Info Customer Service Settlement CGF / CGF lite Rocket Growth

Logistics Info

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

Update a return location

# 01

Summary

# 02

Details

Available buyer market: Korea, Taiwan

Update a return location.
The return location code (returnCenterCode) is needed to update the return location.

You can get the return location code using Return Location List Query API.

Path

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

Example endpoint

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

URL API Name

UPDATE_SHIPPING_CENTER_BY_RETURN_CENTER_CODE

# 03

Path parameters

Name	Type	Description
vendorId*	string	Seller ID Unique code issued to Vendor by Coupang ex) A00012345
returnCenterCode*	number	Return location code

# 04

Request body

Request parameters

Body parameter

Name

Type

Description

vendorId*

string

Seller ID
Unique code issued to Vendor by Coupang
ex) A00012345

returnCenterCode*

string

Return location code

userId*

string

User ID(Coupang WING ID)

shippingPlaceName

string

Name of return location
If "null," the name of return location stays the same.

usable

string

Usable Y/N

placeAddresses*

object[]

Address of return location

addressType

placeAddresses[].addressType

string

Address type
JIBUN, JIBUN&ROADNAME

CODE	Mean
JIBUN	Land lot number
ROADNAME	Road name

companyContactNumber

placeAddresses[].companyContactNumber

string

Phone number, e.g.: xx-yyy-zzzz,

	Min~Max
x	2~4 digits
y	3~4 digits
z	4 digits

phoneNumber2

placeAddresses[].phoneNumber2

string

Secondary phone number (format: Same as Phone Number 1)

returnZipCode

placeAddresses[].returnZipCode

string

Zip code: Numeric, min. 5 digits and max. 6 digits

returnAddress

placeAddresses[].returnAddress

string

Address, max. length of 150

returnAddressDetail

placeAddresses[].returnAddressDetail

string

Detailed address, max. length of 200

goodsflowInfoDto*

object

Info about Goodflow shipment integration

vendorCreditFee05kg

goodsflowInfoDto.vendorCreditFee05kg

number

Credit fee on a product of 5kg (Seller credit)
Must be greater than 0
As it's not used anywhere else, enter the return shipping fee used for Product Creation API
Subject: vendorCreditFee05kg~returnFee20kg

vendorCreditFee10kg

goodsflowInfoDto.vendorCreditFee10kg

number

Credit fee on a product of 10kg (Seller credit)
Must be greater than 0

vendorCreditFee20kg

goodsflowInfoDto.vendorCreditFee20kg

number

Credit fee on a product of 20kg (Seller credit)
Must be greater than 0

vendorCashFee05kg

goodsflowInfoDto.vendorCashFee05kg

number

Upfront fee on a product of 5kg (Seller cash)
Must be greater than 0

vendorCashFee10kg

goodsflowInfoDto.vendorCashFee10kg

number

Upfront fee on a product of 10kg (Seller cash)
Must be greater than 0

vendorCashFee20kg

goodsflowInfoDto.vendorCashFee20kg

number

Upfront fee on a product of 20kg (Seller cash)
Must be greater than 0

consumerCashFee05kg

goodsflowInfoDto.consumerCashFee05kg

number

On-arrival fee on a product of 5kg (Buyer cash)
Must be greater than 0

consumerCashFee10kg

goodsflowInfoDto.consumerCashFee10kg

number

On-arrival fee on a product of 10kg (Buyer cash)
Must be greater than 0

consumerCashFee20kg

goodsflowInfoDto.consumerCashFee20kg

number

On-arrival fee on a product of 20kg (Buyer cash)
Must be greater than 0

returnFee05kg

goodsflowInfoDto.returnFee05kg

number

Return fee on a product of 5kg
Must be greater than 0

returnFee10kg

goodsflowInfoDto.returnFee10kg

number

Return fee on a product of 10kg
Must be greater than 0

returnFee20kg

goodsflowInfoDto.returnFee20kg

number

Return fee on a product of 20kg
Must be greater than 0

Request exampleapplication/json

{
  "userId": "testId",
  "vendorId": "A00012345",
  "returnCenterCode": "1000558900",
  "shippingPlaceName": "반품지 -20200214-2modi",
  "usable": "true",
  "goodsflowInfoOpenApiDto": {
    "vendorCreditFee05kg": "2500",
    "vendorCreditFee10kg": "2500",
    "vendorCreditFee20kg": "2500",
    "vendorCashFee05kg": "2500",
    "vendorCashFee10kg": "2500",
    "vendorCashFee20kg": "2500",
    "consumerCashFee05kg": "2500",
    "consumerCashFee10kg": "2500",
    "consumerCashFee20kg": "2500",
    "returnFee05kg": "2500",
    "returnFee10kg": "2500",
    "returnFee20kg": "2500"
  },
  "placeAddresses": [
    {
      "addressType": "JIBUN",
      "companyContactNumber": "070-****-8008",
      "phoneNumber2": "010-****-7993",
      "returnZipCode": "110794",
      "returnAddress": "서울특별시 종로구 인사동5길 25 (인사동)",
      "returnAddressDetail": "하나로빌딩"
    }
  ]
}

# 05

Response body

Response message

Name	Type	Description
code	integer	Server response code
message	string	Server response message
data	object	Result of updating return location
resultCode data.resultCode	string	Result code SUCCESS or FAIL
resultMessage data.resultMessage	string	Result message

Response Example

{
  "code": 200,
  "message": "SUCCESS",
  "data": {
    "resultCode": "SUCCESS",
    "resultMessage": "Modify successfully"
  }
}

# 06

Error codes

HTTP	Code	Message
400	HTTP_400	Bad Request

Error specification

HTTP	Type	Error message	Solution
400	400 (check request parameter)	params are not allowed null...	Check if the seller ID (vendorId), return location code (returnCenterCode) and user ID (userId) are null.
400	400 (check request parameter)	The address name is already registered (Duplicate address code: 1000*******)	Check if a return location with the same name (shippingPlaceName) is already registered. Do not double-register one return location.
400	400 (Request parameter check)	Please input the correct phone number format including numbers and '-' (min 9, max 13)	Check if companyContactNumber or phoneNumber2 value was entered in the right format. It should be 9 ~ 13 digits including '-'.