API 적용 가능한 구매자 사용자 지역: 한국
현재 설정된 모든 계약의 쿠폰 예산을 조회하기 위한 API입니다.
쿠폰의 사용을 위한 예산은 각각의 계약 조건에 따라 각 월별로 설정이 되기에 계약 및 조회를 원하는 월별로 조회가 가능합니다.
쿠폰의 사용을 위한 예산은 각각의 계약 조건에 따라 각 월별로 설정이 되기에 계약 및 조회를 원하는 월별로 조회가 가능합니다.
Path
GET
/v2/providers/fms/apis/api/v1/vendors/{vendorId}/budgets
Example Endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/budgets?contractId=-1&targetMonth=2017-08
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
판매자ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345
|
||||
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| contractId | Number |
업체의 계약서 아이디 (자유계약의 경우 -1 입력)
|
|||||
| targetMonth | String |
조회하고자 하는 예산월
yyyy-MM
targetMonth를 입력하지 않으면 현재 월에 해당하는 예산이 조회됨.
|
|||||
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 | Array |
예산 현황 리스트 데이터
|
||||
| success | Boolean |
성공 여부
true or false
|
||||
| content | Array |
예산현황 리스트
|
||||
| contractId | Number |
업체의 계약서 아이디
예) 1, 2
|
||||
| targetMonth | String |
조회하고자 하는 예산월
예) 2017-08
|
||||
| vendorShareRatio | Number |
분담율(%) : 해당 계약서에 명시된 쿠팡과의 분담율
예) 100
|
||||
| totalBudgetAmount | Number |
해당월에 설정된 예산
예) 1000000
|
||||
| usedBudgetAmount | Number |
해당월에 사용된 예산
예) 50.00
|
||||
| Pagination | Array |
페이징
|
||||
| countPerPage | Number |
페이지별 데이터 Count
예) 10, 20, 30
|
||||
| currentPage | Number |
현재 페이지
예) 1
|
||||
| totalPages | Number |
전체 페이지 Count
예) 1000
|
||||
| totalElements | Number |
전체 데이터 Count
예) 1000
|
||||
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": [
{
"contractId": 2,
"targetMonth": "2017-08",
"vendorShareRatio": 100,
"totalBudgetAmount": 1000000,
"usedBudgetAmount": 50
}
],
"pagination": null
}
}Error Spec
| HTTP 상태 코드 (오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 401 (요청변수확인) | 업체정보의 권한을 확인하세요. | 판매자ID(vendorId) 값을 올바로 입력했는지 확인합니다. |
| 400 (요청변수확인) | Invalid format: \"2020\" is too short | 조회하고자 하는 예산월(targetMonth) 값을 올바로 입력했는지 확인합니다. |