POST
/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items2609170000[즉시할인쿠폰] 아이템 생성
KRTW
# 01
요약
[즉시할인쿠폰] 아이템 생성
# 02
상세
API 적용 가능한 구매자 사용자 지역: 한국
생성된 쿠폰을 개별 아이템에 적용하기 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어
실제 API 수행 결과 값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인합니다.
경로
POST/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items
예시 엔드포인트
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/68/items# 03
Path 파라미터
| Name | Type | Description |
|---|---|---|
| vendorId* | string | 판매자ID 쿠팡에서 업체에게 발급한 고유 코드 예) A00012345 |
| couponId* | number | 적용할 쿠폰ID
|
# 04
요청 본문
요청 파라미터
본문 파라미터
| Name | Type | Description |
|---|---|---|
| vendorItems* | object[] | 쿠폰을 적용할 옵션ID 한 번에 적용할 옵션ID 수는 10,000개를 초과할 수 없음 |
요청 예시application/json
{
"vendorItems": [
3226138951,
3226138847
]
}# 05
응답 본문
응답 메시지
| Name | Type | Description |
|---|---|---|
| code | integer | 서버 응답 코드
|
| message | string | 서버 응답 메세지
|
| httpStatus | integer | HTTP Status Code(서버 응답 코드와 동일한 값)
|
| httpStatusMessage | string | HTTP Status Message (서버 응답 메세지와 동일한 값)
|
| errorMessage | string | HTTP Status 200을 제외한 나머지 Status에서 서버 내 상세한 실패 이유 메세지가 담깁니다.
|
| data | object | 수행 성공 여부 데이터
|
| success data.success | boolean | 성공 여부 true or false |
| content data.content | object | 처리 상태를 조회할 수 있는 요청아이디 데이터
|
| requestedId data.content.requestedId | string | 처리 상태 조회를 위한 요청아이디 예) 1542675975663862164 |
| success data.content.success | boolean | 성공 여부 true or false |
| Pagination data.Pagination | object[] | 페이징 없음
|
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"requestedId": "17258005702255081464",
"success": true
},
"pagination": null
}
}# 06
에러 코드
| HTTP | 코드 | 메시지 |
|---|---|---|
| 400 | HTTP_400 | Bad Request |
오류 사양
| HTTP | 유형 | 오류 메시지 | 해결 방법 |
|---|---|---|---|
| 400 | 400 (요청변수확인) | vendorItems may not be empty, vendorItems size must be between 1 and 10000 | 쿠폰을 적용할 옵션ID(vendorItems) 를 올바로 입력했는지 확인합니다. 한 번에 적용할 옵션ID 수는 10,000개를 초과할 수 없습니다. |
| 400 | 400 (요청변수확인) | 업체정보의 권한을 확인하세요 | 판매자ID(vendorId) 값을 올바로 입력했는지 확인합니다. |
| 400 | 400 (요청변수확인) | 쿠폰아이디를 확인해주세요 208463**** | 쿠폰ID(couponId) 값을 올바로 입력했는지 확인합니다. |