coupang
API 문서
상품 API카테고리 API브랜드 API배송 / 주문 API반품 API교환 API프로모션 / 쿠폰물류 정보고객 문의정산Rocket Growth
GET/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/products/items/cashbackv1

[도서] 상품 캐시백 검색

# 01

요약

API 적용 가능한 구매자 사용자 지역: 한국 해당 옵션 ID 에 적용된 캐시백 룰 정보를 조회합니다. 캐시백이 적용되지 않은 옵션 ID(vendorItemId)를 조회 시 404 또는 400 에러가 발생합니다.

# 02

상세

API 적용 가능한 구매자 사용자 지역: 한국
해당 옵션 ID 에 적용된 캐시백 룰 정보를 조회합니다.
캐시백이 적용되지 않은 옵션 ID(vendorItemId)를 조회 시 404 또는 400 에러가 발생합니다.

Path

GET

/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/products/items/cashback

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/products/items/cashback?ruleId=1&vendorItemId=3000000005

Request Parameters

Path Segment Parameter

Name Required Type Description
vendorId O  String
판매자 ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345

Query String Parameter

Name Required Type Description
ruleId O Number
Rule ID
캐시백 관련 계약완료 후 제공받은 룰 아이디를 입력
vendorItemId O Number
옵션 ID

Request Example

 
not require body

Response Message

Name Type Description
code Number
Http request status code
예) 200, 400, 500
message String
성공 혹은 실패에 따른 결과 메시지
200: OK
400: Bad request , will show corresponding bad request message
500: Internal error
data Object
 
  ruleId Number
Rule ID
  valueType String
캐시백 유형
FIXED(정액할인), FIXED_WITH_QUANTITY(수량별 정액할인)
  value Number
적립값
최소값은 1
  maxAmount String
최대적립금액
최소값은 0;FIXED 혹은 FIXED_WITH_QUANTITY 시 이 파라미터는 필요하지 않음
  vendorItemId Number
옵션 ID
  startAt String
시작일
형태 yyyy-MM-dd HH:mm:ss
  endAt String
종료일
형태 yyyy-MM-dd HH:mm:ss
  disabled boolean
캐시백 룰 적용 가능 여부
  disabledAt String
캐시백 룰 적용 불가능 일자
형태 yyyy-MM-dd HH:mm:ss

Response Example

{
  "code": "200",
  "message": "OK",
  "data": {
    "vendorItemId": "3000000005",
    "vendorId": "A00012345",
    "valueType": "FIXED",
    "value": 1000,
    "startAt": "2016-12-29 09:43:54",
    "maxAmount": 0,
    "ruleId": 1,
    "endAt": "2017-01-01 09:43:54",
    "disabledAt": null,
    "disabled": false
  }
}

Error Spec

HTTP 상태 코드(오류 유형) 오류 메시지 해결 방법
404 (요청변수확인) Can not find promotion with given condition vendorItemId : 7015***6995 조회하려는 옵션 ID (vendorItemId) 에 캐시백이 적용 되었는지 확인합니다. 
400 (요청변수확인)

VendorItemId can't be null

 옵션 ID (vendorItemId) 를 입력했는지 확인합니다. 
400 (요청변수확인) Invalid vendorItemId, vendorItemId doesn't exist or doesn't belong to corresponding vendorId 조회하려는 옵션 ID (vendorItemId) 가 올바른지 또는 캐시백이 적용되었는지 확인합니다. 

URL API Name

GET_PRODUCT_CASHBACK