현재 설정된 계약 단건을 조회하기 위한 API입니다.
Path
GET/v2/providers/fms/apis/api/v2/vendors/{vendorId}/contract
Example Endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/contract?contractId=9962Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
판매자ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345 |
||||
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| contractId | O | Number |
업체의 계약서ID
|
||||
Request Example
not require body
Response Message
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| code | Number |
서버 응답 코드
|
||||
| message | String |
서버 응답 메세지
|
||||
| httpStatus | Number |
HTTP Status Code(서버 응답 코드와 동일한 값)
|
||||
| httpStatusMessage | String |
HTTP Status Message (서버 응답 메세지와 동일한 값)
|
||||
| errorMessage | String |
HTTP Status 200을 제외한 나머지 Status에서 서버 내 상세한 실패 이유 메세지가 담깁니다.
|
||||
| data | Object |
계약서 단건 데이터
|
||||
| success | Boolean |
성공 여부
true or false
|
||||
| content | Object |
계약서 단건
|
||||
| contractId | Number |
업체의 계약서ID
예) 1, 2
|
||||
| vendorContractId | Number |
업체의 계약서 코드(쿠팡 관리 코드)
예) -1, 1, 2
|
||||
| sellerId | String |
판매자ID
예) A00012345
|
||||
| sellerShareRatio | Number |
해당 계약서에 명시된 업체 분담율(%)
예) 100
|
||||
| coupangShareRatio | Number |
해당 계약서에 명시된 쿠팡 분담율(%)
예) 100
|
||||
| gmvRatio | Number |
월별 매출 비율, 월별 예산을 쿠팡에서의 매출을 기반으로 자동 생성
예) 100
|
||||
| start | String |
시작일시
예) 2018-01-22 00:00:00
|
||||
| end | String |
종료일시
예) 2018-12-31 23:59:59
|
||||
| type | String |
계약 유형
예) CONTRACT_BASED, NON_CONTRACT_BASED
|
||||
| usedBudget | Boolean |
예산제한 사용 여부
예) true, false
현재는 사용되지 않는 필드이며 true가 기본값입니다.
|
||||
| modifiedAt | String |
최종 수정 일시
예) 2017-09-25 11:40:01
|
||||
| modifiedBy | String |
최종 수정자 ID
|
||||
| Pagination | null |
단건 조회로 페이징 없음
|
||||
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"contractId": 9962,
"vendorContractId": 7,
"sellerId": "A00012345",
"sellerShareRatio": 100,
"coupangShareRatio": 0,
"gmvRatio": 100,
"start": "2018-01-22 00:00:00",
"end": "2018-12-31 23:59:59",
"type": "CONTRACT_BASED",
"useBudget": true,
"modifiedAt": "2018-01-22 16:07:10",
"modifiedBy": "allie"
},
"pagination": null
}
}Error Spec
| HTTP 상태 코드 (오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 401 (요청변수확인) | 업체정보의 권한을 확인하세요. | 판매자ID(vendorId) 값을 올바로 입력했는지 확인합니다. |
| 404 (요청변수확인) | 조회 할 수 없는 계약서 아이디 입니다. | 계약서ID(contractId) 값을 올바로 입력했는지 확인합니다. |
| 400 (요청변수확인) | Required Long parameter 'contractId' is not present | 계약서ID(contractId) 값을 입력했는지 확인합니다. |