상품 API 카테고리 API 브랜드 API 배송 / 주문 API 반품 API 교환 API 프로모션 / 쿠폰 물류 정보 고객 문의 정산 CGF / CGF lite Rocket Growth

물류 정보

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

반품지 생성

KRTW

# 01

요약

반품지 생성

# 02

상세

API 적용 가능한 구매자 사용자 지역: 한국, 대만

반품지를 생성합니다.

판매자는 이 API를 사용하여, 하나 이상의 반품지를 만들 수 있습니다.

생성된 반품지는 상품 등록 시 입력하는 반품지 정보에 사용됩니다.

※ 택배사 계약 코드가 없을 경우, 반품지를 생성하지 않고 상품을 등록할 수 있으며

해외 배송 상품은 반드시 반품지 생성이 필요합니다. *추가 가이드 (Click)

경로

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

예시 엔드포인트

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

URL API Name

UPDATE_SHIPPING_CENTER_BY_VENDOR

# 03

Path 파라미터

Name	Type	Description
vendorId*	string	판매자 ID 쿠팡에서 업체에게 발급한 고유 코드 예) A00012345

# 04

요청 본문

요청 파라미터

본문 파라미터

Name

Type

Description

vendorId*

string

판매자 ID

쿠팡에서 업체에게 발급한 고유 코드
예) A00012345

userId*

string

사용자 아이디(쿠팡 WING 로그인 계정)

shippingPlaceName*

string

반품지 이름

goodsflowInfoOpenApiDto*

object

택배사 정보

deliverCode

goodsflowInfoOpenApiDto.deliverCode

string

택배사 코드

CODE	NAME
HYUNDAI	롯데택배
KGB	로젠택배
EPOST	우체국
HANJIN	한진택배
CJGLS	CJ대한통운
ILYANG	일양택배

위 택배사들만 반품지 택배사로 등록가능합니다.

deliverName

goodsflowInfoOpenApiDto.deliverName

string

택배사명

contractNumber

goodsflowInfoOpenApiDto.contractNumber

string

택배사 계약코드

contractCustomerNumber

goodsflowInfoOpenApiDto.contractCustomerNumber

string

업체코드
우체국 택배 이용 시만 입력 필요

vendorCreditFee05kg

goodsflowInfoOpenApiDto.vendorCreditFee05kg

string

상품이 5kg일때의 신용요금 (판매자 신용)

0보다 커야합니다

※요금 입력 시, 주의사항

고객에게 부과하는 금액이 아닌, 굿스플로 택배사와 계약한 금액을 입력해주시기 바랍니다.
계약한 금액보다 크게 입력할 경우, 입력한 대로 금액이 지불될 수 있음)

대상:vendorCreditFee05kg~returnFee20kg

vendorCreditFee10kg

goodsflowInfoOpenApiDto.vendorCreditFee10kg

string

상품이 10kg일때의 신용요금 (판매자 신용)
0보다 커야합니다.

vendorCreditFee20kg

goodsflowInfoOpenApiDto.vendorCreditFee20kg

string

상품이 20kg일때의 신용요금 (판매자 신용)
0보다 커야합니다.

vendorCashFee05kg

goodsflowInfoOpenApiDto.vendorCashFee05kg

string

상품이 5kg일때의 선불요금 (판매자 현금)
0보다 커야합니다.

vendorCashFee10kg

goodsflowInfoOpenApiDto.vendorCashFee10kg

string

상품이 10kg일때의 선불요금 (판매자 현금)
0보다 커야합니다.

vendorCashFee20kg

goodsflowInfoOpenApiDto.vendorCashFee20kg

string

상품이 20kg일때의 선불요금 (판매자 현금)
0보다 커야합니다.

consumerCashFee05kg

goodsflowInfoOpenApiDto.consumerCashFee05kg

string

상품이 5kg일때의 착불요금(구매자 현금)
0보다 커야합니다.

consumerCashFee10kg

goodsflowInfoOpenApiDto.consumerCashFee10kg

string

상품이 10kg일때의 착불요금(구매자 현금)
0보다 커야합니다.

consumerCashFee20kg

goodsflowInfoOpenApiDto.consumerCashFee20kg

string

상품이 20kg일때의 착불요금(구매자 현금)
0보다 커야합니다.

returnFee05kg

goodsflowInfoOpenApiDto.returnFee05kg

string

상품이 5kg일때의 반품비
0보다 커야합니다.

returnFee10kg

goodsflowInfoOpenApiDto.returnFee10kg

string

상품이 10kg일때의 반품비
0보다 커야합니다.

returnFee20kg

goodsflowInfoOpenApiDto.returnFee20kg

string

상품이 20kg일때의 반품비
0보다 커야합니다.

placeAddresses*

object[]

반품지 주소

addressType

placeAddresses[].addressType

string

주소 타입
JIBUN, JIBUN&ROADNAME

CODE	Mean
JIBUN	지번
ROADNAME	도로명

companyContactNumber

placeAddresses[].companyContactNumber

string

전화번호, e.g. : xx-yyy-zzzz

구분	Min~Max
x	2~4자
y	3~4자
z	4자

phoneNumber2

placeAddresses[].phoneNumber2

string

보조 전화번호 (형식 : 전화번호1과 같습니다)

returnZipCode

placeAddresses[].returnZipCode

string

우편번호 : 숫자, 최소길이 5, 최대길이 6

returnAddress

placeAddresses[].returnAddress

string

주소, 최대길이는 150

returnAddressDetail

placeAddresses[].returnAddressDetail

string

상세주소, 최대길이는 200

요청 예시application/json

{
  "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"
    }
  ]
}

# 05

응답 본문

응답 메시지

Name	Type	Description
code	string	서버 응답 코드
message	string	서버 응답 메시지
data	object	반품지 생성 결과
resultCode data.resultCode	string	결과 코드 SUCCESS or FAIL
resultMessage data.resultMessage	string	결과 메시지(반품지 코드) returnCenterCode

Response Example

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

# 06

에러 코드

HTTP	코드	메시지
400	HTTP_400	Bad Request

오류 사양

HTTP	유형	오류 메시지	해결 방법
400	400 (요청변수확인)	등록된 서비스 신청 정보가 있습니다	동일한 반품지이름(shippingPlaceName) 및 주소지(returnAddress, returnAddressDetail)로 등록된 반품지가 이미 존재하는지 확인합니다. 같은 반품지이름, 주소지 값으로 중복등록이 불가합니다.
400	400 (요청변수확인)	[출고지중복] 이미 등록된 주소지명이 있습니다 (중복 주소지 코드:1000*******)	동일한 반품지이름(shippingPlaceName)의 반품지가 이미 등록되었는지 확인합니다. 반품지를 중복 등록하지 않도록 처리합니다.
400	400 (중복입력)	[출고지중복] Duplicated request. name: *****	동일한 shippingPlaceName 값을 입력했는지 확인합니다.
500	500 (요청변수확인)	shipping-places create error.	택배사 계약코드(contractNumber) 값을 올바로 입력했는지 확인합니다.
500	500 (요청변수확인)	등록되었으나 계약확인에 실패하였습니다	택배사 계약코드(contractNumber) 값을 올바로 입력했는지 확인합니다.
400	400 (요청변수확인)	Please input the correct phone number format including numbers and '-' (min 9, max 13)	companyContactNumber 또는 phoneNumber2 값을 올바른 형식의 전화번호로 입력했는지 확인합니다. '-'를 포함하여 최소 9자 이상 최대 13자 이하로 입력합니다.
500	500 (요청변수확인)	서버 에러 (알 수 없는 에러 / 신규 에러)	업체코드(contractCustomerNumber) 값을 올바로 입력했는지 확인합니다. 해당값은 택배사가 우체국(EPOST)인 경우에만 입력합니다.
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)가 올바로 입력됐는지 확인합니다.