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

Logistics Info

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

Create a return location

# 01

Summary

# 02

Details

Available buyer market: Korea, Taiwan

Create a return location.

Sellers use this API to create more than one return locations.

A created return location is used in the return info entered to list a product.

※ If you don't have a courier contract code, you can list a product without creating a return location, and for overseas shipping products a return location must be created. *Additional Guide (Click)

Path

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

Example endpoint

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

URL API Name

UPDATE_SHIPPING_CENTER_BY_VENDOR

# 03

Path parameters

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

# 04

Request body

Request parameters

Body parameter

Name

Type

Description

vendorId*

string

Seller ID

Unique code issued to Vendor by Coupang
ex) A00012345

userId*

string

User ID (log-in account for Coupang WING)

shippingPlaceName*

string

Name of return location

goodsflowInfoOpenApiDto*

object

Courier info

deliverCode

goodsflowInfoOpenApiDto.deliverCode

string

Courier code

CODE	NAME
HYUNDAI	Lotte Logistics
KGB	Logen Logistics
EPOST	Korea Post
HANJIN	Hanjin Logistics
CJGLS	CJ Logistics
ILYANG	Ilyang Logistics

Only the above couriers can be registered for return shipping.

deliverName

goodsflowInfoOpenApiDto.deliverName

string

Name of courier

contractNumber

goodsflowInfoOpenApiDto.contractNumber

string

Courier contract code

contractCustomerNumber

goodsflowInfoOpenApiDto.contractCustomerNumber

string

Vendor code
Needed only when Korea Post is used

vendorCreditFee05kg

goodsflowInfoOpenApiDto.vendorCreditFee05kg

number

Credit fee on a product of 5kg (Seller credit)

Must be greater than 0

※ Requirements for the fee

Enter the fee agreed upon by Goodsflow courier, not that charged to Customer.
The fee entered may be paid even it is greater than agreed upon.

Subject: vendorCreditFee05kg~returnFee20kg

vendorCreditFee10kg

goodsflowInfoOpenApiDto.vendorCreditFee10kg

number

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

vendorCreditFee20kg

goodsflowInfoOpenApiDto.vendorCreditFee20kg

number

Credit fee on a product of 20kg (Seller credit)

Must be greater than 0

vendorCashFee05kg

goodsflowInfoOpenApiDto.vendorCashFee05kg

number

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

vendorCashFee10kg

goodsflowInfoOpenApiDto.vendorCashFee10kg

number

Upfront fee on a product of 10kg (Seller cash)

Must be greater than 0

vendorCashFee20kg

goodsflowInfoOpenApiDto.vendorCashFee20kg

number

Upfront fee on a product of 20kg (Seller cash)

Must be greater than 0

consumerCashFee05kg

goodsflowInfoOpenApiDto.consumerCashFee05kg

number

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

consumerCashFee10kg

goodsflowInfoOpenApiDto.consumerCashFee10kg

number

On-arrival fee on a product of 10kg (Buyer cash)

Must be greater than 0

consumerCashFee20kg

goodsflowInfoOpenApiDto.consumerCashFee20kg

number

On-arrival fee on a product of 20kg (Buyer cash)

Must be greater than 0

returnFee05kg

goodsflowInfoOpenApiDto.returnFee05kg

number

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

returnFee10kg

goodsflowInfoOpenApiDto.returnFee10kg

number

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

returnFee20kg

goodsflowInfoOpenApiDto.returnFee20kg

number

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

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

	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
Example

# 05

Response body

Response message

Name	Type	Description
code	string	Server response code
message	string	Server response message
data	object	Result of creating return location
resultCode data.resultCode	string	Result code SUCCESS or FAIL
resultMessage data.resultMessage	string	Result message (return location code) returnCenterCode

Response Example

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

# 06

Error codes

HTTP	Code	Message
400	HTTP_400	Bad Request

Error specification

HTTP	Type	Error message	Solution
400	400 (check request parameter)	Registered service request info already exists.	Check if the return location with the same name (shippingPlaceName) or address (returnAddress, returnAddressDetail) already exists. It's impossible to double-register one return location with the same name or address.
400	400 (check request parameter)	[Duplicate Shipping Location] 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 (Duplicate entry)	[Duplicate shipping location] Duplicated request. name:xxxxx	Check if the same returnAddress value was entered.
500	500 (check request parameter)	shipping-places create error.	Check if the courier contract code (contractNumber) is correct.
500	500 (check request parameter)	It has been registered, but contract confirmation has failed.	Check if the courier contract code (contractNumber) is correct.
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 '-'.
500	500 (check request parameter)	Server error (unknown/new error)	Check if the vendor code (contractCustomerNumber) is correct. This value is required only if the courier is Korea Post (EPOST).
400	400 (check request parameter)	Invalid vendor ID	Check if the vendorID value is correct
400	400 (check request parameter)	The vendorId in path or requestBody doesn't match the one got from api-gateway.	Check if the seller ID (VendorId) is correct.