Returun Request or Withdraw
Vendor 측으로 회수지시 또는 회수지시철회를 전송하기 위한 API 입니다.
- API 호출 방향 : Coupang -> Vendor
- URL : /v1/3pfl/return/request
- Interface Style : Restful API
- HTTP Protocol : HTTPS
- Method : POST
Request Body
| Property Name | Parent Object | Data Type | Size | Mandatory | Description |
| collectingRequestType | Root | String | Y | REQUEST(회수 요청), CANCEL(회수 요청 철회) | |
| collectingType | Root | String | Y |
회수 타입 enum RETURN(반품) |
|
| returnNumber | Root | Long | Y | 회수 접수번호 | |
| returnInvoiceNumber | Root | String | Y | 회수 송장번호 (회수 철회시에만 값이 채워집니다. 회수요청시에는 null입니다) | |
| orderNumber | Root | Long | Y | 원주문번호 | |
| orderInvoiceNumber | Root | String | Y | 원주문 송장번호 | |
| shipmentId | Root | Long | Y | ||
| senderAddress | Root | Array | Y | 발송인(고객) | |
| name | senderAddress | String | Y | ||
| phoneNumber | senderAddress | String | Y | ||
| mobileNumber | senderAddress | String | Y | ||
| zipCode | senderAddress | String | Y | ||
| address | senderAddress | String | Y | ||
| addressDetail | senderAddress | String | Y | ||
| recipientAddress | Root | Array | Y | 수하인(업체, 반품지) | |
| name | recipientAddress | String | Y | ||
| phoneNumber | recipientAddress | String | Y | ||
| mobileNumber | recipientAddress | String | Y | ||
| zipCode | recipientAddress | String | Y | ||
| address | recipientAddress | String | Y | ||
| addressDetail | recipientAddress | String | Y | ||
| returnCenterCode | Root | String | Y | ||
| message | Root | String | Y | ||
| returnVendorItemList | Root | Array | Y | 회수 요청 벤더 아이템 목록 | |
| vendorItemId | returnVendorItemList | Long | Y | 벤더 아이템 아이디 | |
| vendorItemName | returnVendorItemList | String | Y | 벤더 아이템 이름 | |
| quantity | returnVendorItemList | Integer | Y | 벤더 아이템 수량 | |
| returnItemList | returnVendorItemList | Array | Y | 회수 요청 SKU 목록 | |
| skuId | returnItemList | Long | Y | SKU ID | |
| quantity | returnItemList | Integer | Y | SKU 수량 | |
| promisedReturnDate | Root | String | Y | 회수 예정일 | |
| uniqueCode | Root | String | Y | 회수 요청에서 값을 채워서 Vendor로 보내면, 회수 철회시에 Vendor가 해당 값을 보고 정확한 반품 송장을 식별할 수 있게 됩니다. (return Invoice Number 대체 용도로 optional하게 사용 가능) |
Request Example
{
"collectingRequestType": "REQUEST",
"collectingType": "RETURN",
"returnNumber": 9900001,
"returnInvoiceNumber": null,
"orderNumber": 10012345678,
"orderInvoiceNumber": "1234567890",
"shipmentId": 150000000001,
"senderAddress":
{
"name": "고객명",
"phoneNumber": "010-1111-2222",
"mobileNumber": "010-1111-2222",
"zipCode": "01010",
"address": "고객 주소",
"addressDetail": "고객 상세 주소"
},
"recipientAddress":
{
"name": "회수지명",
"phoneNumber": "1234-5678",
"mobileNumber": "1234-5678",
"zipCode": "01001",
"address": "회수지 주소",
"addressDetail": "회수지 상세 주소"
},
"returnCenterCode": "CENTER001",
"message": "고객 반품 메시지",
"returnVendorItemList": [
{
"vendorItemId": 88000001,
"vendorItemName": "상품명",
"quantity": 1,
"returnItemList": [
{
"skuId": 10004321,
"quantity": 1
}
]
}
],
"promisedReturnDate": "2020-10-21",
"uniqueCode": "R12345678"
}
Response
| Property Name | Data Type | Size | Mandatory | Description |
| erpRtnOrderNumber | String | Y | 회수 요청시 Vendor에서 생성한 회수 송장번호 -> 쿠팡에서 return Invoice Number로 사용됩니다. | |
| errorCode | String | 20 | N |
결과값
|
| errorReason | String | 100 | N | 에러 사유 |
Response Example
{
"erpRtnOrderNumber": "R87654321",
"errorCode": "0",
"errorReason": null
}
유의사항
- returnVendorItemList 필드로 VendorItem을 부분적으로 반품요청할 수 있습니다.
- 다만, returnItemList를 사용하여 1개의 vendorItem에 대해 sku를 부분적으로 반품요청 드리지는 않습니다.
- vendorItem에 연결된 모든 skuList가 요청에 무조건 포함됩니다.