POST
/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/returnShippingCentersv1반품지 생성
# 01
요약
API 적용 가능한 구매자 사용자 지역: 한국, 대만 반품지를 생성합니다. 판매자는 이 API를 사용하여, 하나 이상의 반품지를 만들 수 있습니다. 생성된 반품지는 상품 등록 시 입력하는 반품지 정보에 사용됩니다. ※ 택배사 계약 코드가 없을 경우, 반품지를 생성하지 않고 상품을 등록할 수 있으며 해외 배송 상품은 반드시 반품지 생성이 필요합니다.
# 02
상세
API 적용 가능한 구매자 사용자 지역: 한국, 대만
반품지를 생성합니다.
판매자는 이 API를 사용하여, 하나 이상의 반품지를 만들 수 있습니다.
생성된 반품지는 상품 등록 시 입력하는 반품지 정보에 사용됩니다.
※ 택배사 계약 코드가 없을 경우, 반품지를 생성하지 않고 상품을 등록할 수 있으며
해외 배송 상품은 반드시 반품지 생성이 필요합니다. *추가 가이드 (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
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
판매자 ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345 |
||||
Body Parameter
| Name | Required | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| vendorId | O | String |
판매자 ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345 |
||||||||||||||||||
| userId | O | String |
사용자 아이디(쿠팡 WING 로그인 계정)
|
||||||||||||||||||
| shippingPlaceName | O | String |
반품지 이름
|
||||||||||||||||||
| goodsflowInfoOpenApiDto | O | Object |
택배사 정보
|
||||||||||||||||||
| deliverCode | String |
택배사 코드
위 택배사들만 반품지 택배사로 등록가능합니다.
|
|||||||||||||||||||
| deliverName | String |
택배사명
|
|||||||||||||||||||
| contractNumber | String |
택배사 계약코드
|
|||||||||||||||||||
| contractCustomerNumber | String |
업체코드
우체국 택배 이용 시만 입력 필요
|
|||||||||||||||||||
| vendorCreditFee05kg | Number |
상품이 5kg일때의 신용요금 (판매자 신용)
0보다 커야합니다
※요금 입력 시, 주의사항
대상:vendorCreditFee05kg~returnFee20kg
|
|||||||||||||||||||
| vendorCreditFee10kg | Number |
상품이 10kg일때의 신용요금 (판매자 신용)
0보다 커야합니다.
|
|||||||||||||||||||
| vendorCreditFee20kg | Number |
상품이 20kg일때의 신용요금 (판매자 신용)
0보다 커야합니다.
|
|||||||||||||||||||
| vendorCashFee05kg | Number |
상품이 5kg일때의 선불요금 (판매자 현금)
0보다 커야합니다.
|
|||||||||||||||||||
| vendorCashFee10kg | Number |
상품이 10kg일때의 선불요금 (판매자 현금)
0보다 커야합니다.
|
|||||||||||||||||||
| vendorCashFee20kg | Number |
상품이 20kg일때의 선불요금 (판매자 현금)
0보다 커야합니다.
|
|||||||||||||||||||
| consumerCashFee05kg | Number |
상품이 5kg일때의 착불요금(구매자 현금)
0보다 커야합니다.
|
|||||||||||||||||||
| consumerCashFee10kg | Number |
상품이 10kg일때의 착불요금(구매자 현금)
0보다 커야합니다.
|
|||||||||||||||||||
| consumerCashFee20kg | Number |
상품이 20kg일때의 착불요금(구매자 현금)
0보다 커야합니다.
|
|||||||||||||||||||
| returnFee05kg | Number |
상품이 5kg일때의 반품비
0보다 커야합니다.
|
|||||||||||||||||||
| returnFee10kg | Number |
상품이 10kg일때의 반품비
0보다 커야합니다.
|
|||||||||||||||||||
| returnFee20kg | Number |
상품이 20kg일때의 반품비
0보다 커야합니다.
|
|||||||||||||||||||
| placeAddresses | O | Array |
반품지 주소
|
||||||||||||||||||
| addressType | String |
주소 타입
JIBUN, JIBUN&ROADNAME
|
|||||||||||||||||||
| companyContactNumber | String |
전화번호, e.g. : xx-yyy-zzzz
|
|||||||||||||||||||
| phoneNumber2 | String |
보조 전화번호 (형식 : 전화번호1과 같습니다)
|
|||||||||||||||||||
| returnZipCode | String |
우편번호 : 숫자, 최소길이 5, 최대길이 6
|
|||||||||||||||||||
| returnAddress | String |
주소, 최대길이는 150
|
|||||||||||||||||||
| returnAddressDetail | String |
상세주소, 최대길이는 200
|
|||||||||||||||||||
Request Example
{
"userId": "coupang20",
"vendorId": "A00012345",
"shippingPlaceName": "반품지01",
"goodsflowInfoOpenApiDto": {
"deliverCode": "CJGLS",
"contractNumber": "85500067",
"contractCustomerNumber": "",
"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": "02-1234-5678",
"phoneNumber2": "",
"returnZipCode": "112207",
"returnAddress": "경기도 파주시 탄현면 월롱산로",
"returnAddressDetail": "294-58"
}
]
}Response Message
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| code | Number |
서버 응답 코드
|
||||
| message | String |
서버 응답 메시지
|
||||
| data | Array |
반품지 생성 결과
|
||||
| resultCode | String |
결과 코드
SUCCESS or FAIL
|
||||
| resultMessage | String |
결과 메시지(반품지 코드)
returnCenterCode
|
||||
Response Example
{
"code": "200",
"message": "SUCCESS",
"data": {
"resultCode": "SUCCESS",
"resultMessage": "1100044670"
}
}Error Spec
| HTTP 상태 코드(오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 400 (요청변수확인) | 등록된 서비스 신청 정보가 있습니다 | 동일한 반품지이름(shippingPlaceName) 및 주소지(returnAddress, returnAddressDetail)로 등록된 반품지가 이미 존재하는지 확인합니다. 같은 반품지이름, 주소지 값으로 중복등록이 불가합니다. |
| 400 (요청변수확인) | [출고지중복] 이미 등록된 주소지명이 있습니다 (중복 주소지 코드:1000*******) | 동일한 반품지이름(shippingPlaceName)의 반품지가 이미 등록되었는지 확인합니다. 반품지를 중복 등록하지 않도록 처리합니다. |
| 400 (중복입력) |
[출고지중복] Duplicated request. name: ***** |
동일한 shippingPlaceName 값을 입력했는지 확인합니다. |
| 500 (요청변수확인) | shipping-places create error. | 택배사 계약코드(contractNumber) 값을 올바로 입력했는지 확인합니다. |
| 500 (요청변수확인) | 등록되었으나 계약확인에 실패하였습니다 | 택배사 계약코드(contractNumber) 값을 올바로 입력했는지 확인합니다. |
| 400 (요청변수확인) | Please input the correct phone number format including numbers and '-' (min 9, max 13) | companyContactNumber 또는 phoneNumber2 값을 올바른 형식의 전화번호로 입력했는지 확인합니다. '-'를 포함하여 최소 9자 이상 최대 13자 이하로 입력합니다. |
| 500 (요청변수확인) | 서버 에러 (알 수 없는 에러 / 신규 에러) | 업체코드(contractCustomerNumber) 값을 올바로 입력했는지 확인합니다. 해당값은 택배사가 우체국(EPOST)인 경우에만 입력합니다. |
| 400 (요청변수확인) |
Invalid vendor ID |
판매자 ID(vendorId) 값을 올바로 입력했는지 확인합니다. |
| 400 (요청변수확인) |
The vendorId in path or requestBody doesn't match the one got from api-gateway. |
판매자ID(VendorId)가 올바로 입력됐는지 확인합니다. |
URL API Name
UPDATE_SHIPPING_CENTER_BY_VENDOR