coupang
POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/return-exchange-invoices/manual2609170000

회수 송장 등록

KRTW
# 01

요약

회수 송장 등록

# 02

상세

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

반품자동연동 서비스(굿스플로)를 사용하지 않고 자체적으로 반품을 회수하는 판매자의 경우,

반품/교환 접수 시 본 API를 통해 직접 회수 송장을 등록할 수 있습니다.

반품자동연동 서비스(굿스플로)를 이용하는 판매자의 경우 사용하실 필요가 없습니다.

반품 : 반품요청 목록조회 시 반품상태(receiptStatus)가 반품접수(RETURNS_UNCHECKED) 인 경우에 사용 가능
교환 : 교환요청 목록조회 시 회수상태(collectStatus)가 회수연동전(BeforeDirection)인 경우에 사용 가능

※ 회수송장이 등록되었더라도 배송 트래킹이 되지 않거나, 택배기사가 물건을 회수하기 전까지는 고객이 반품요청철회를 할 수 있습니다.

경로

POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/return-exchange-invoices/manual

예시 엔드포인트

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/return-exchange-invoices/manual

URL API Name

CREATE_RETURN_EXCHANGE_INVOICE
# 03

Path 파라미터

NameTypeDescription
vendorId*string
판매자 ID

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

요청 본문

요청 파라미터

본문 파라미터

NameTypeDescription
returnExchangeDeliveryType*string
반품 또는 교환 입력 (RETURN or EXCHANGE)
receiptId*integer
반품 또는 교환 접수ID
반품요청 목록조회, 교환요청 목록조회 API를 통해 확인가능
receiptId는 반드시 number 타입이어야 합니다.
deliveryCompanyCode*string
invoiceNumber*string
운송장번호
regNumberstring
택배사 회수번호 (회수번호 발행 시 입력)
요청 예시application/json
{
  "returnExchangeDeliveryType": "EXCHANGE",
  "receiptId": 101606005,
  "deliveryCompanyCode": "KDEXP",
  "invoiceNumber": "201805291435",
  "regNumber": "1234568"
}
# 05

응답 본문

응답 메시지

NameTypeDescription
codeinteger
HTTP Status Code
messagestring
HTTP Status message
dataobject
deliveryCompanyCode
data.deliveryCompanyCode
string
택배사코드
invoiceNumber
data.invoiceNumber
string
운송장번호
invoiceNumberId
data.invoiceNumberId
integer
내부 invoiceNumberId
receiptId
data.receiptId
integer
반품 또는 교환 접수ID
regNumber
data.regNumber
string
택배사 회수번호
returnDeliveryId
data.returnDeliveryId
integer
내부 returnDeliveryId
returnExchangeDeliveryType
data.returnExchangeDeliveryType
string
RETURN or EXCHANGE

Response Example

{
  "code": 200,
  "message": "OK",
  "data": {
    "deliveryCompanyCode": "KDEXP",
    "invoiceNumber": "201805291435",
    "invoiceNumberId": 26125633,
    "receiptId": 101606005,
    "regNumber": "1234568",
    "returnDeliveryId": 25726758,
    "returnExchangeDeliveryType": "RETURN"
  }
}
# 06

에러 코드

HTTP코드메시지
400HTTP_400Bad Request

오류 사양

HTTP유형오류 메시지해결 방법
400400 (요청변수확인)

배송송장과 같은 송장번호는 입력할 수 없습니다. 송장번호: 2333*****6911.

배송처리 시 입력한 송장과 동일한 회수 송장을 입력했는지 확인합니다. 새로운 회수 송장 번호를 입력합니다.

500500 (요청변수확인)

Invalid value for DeliveryCompanyCodeEnum: ***

택배사 코드(DeliveryCompanyCode)에 지원이 되지 않는 값을 입력했는지 확인합니다. 지원 가능한 택배사 코드를 확인 후 입력합니다. * 택배사 코드

400400 (요청변수확인)

반품 송장 형식이 올바르지 않습니다. 송장번호: 1*** , 택배사: CJGLS

올바른 회수 송장과 택배사를 입력했는지 확인합니다.

400400 (요청변수확인)

Object is null

입력이 누락된 필수항목이 없는지 확인합니다.

500500 (요청변수확인)

null

입력한 receiptId 의 상태가 반품접수, 회수연동전 상태인지 확인합니다. 위 상태가 아닌 receiptId 입력 시 오류가 발생합니다.