Coupang Developer Center

API 적용 가능한 구매자 사용자 지역: 한국

옵션ID 별로 캐시백 룰을 적용합니다.
동일한 캐시백 룰을 사용하는 옵션에 적용할수 있으며 승인완료 이후의 옵션들에만 적용 가능합니다.
* 캐쉬백 기능은 도서 상품 전용으로 쿠팡 영업 담당자와 계약서 작성 및 이용 관련 협의 후 사용 가능합니다.
각 캐시백 유형에 맞는 비즈니스 로직은 아래 테이블을 참조해 주십시오.：

Value type	Explanation	value	maxAmount	고객 주문 예시	캐시백 계산 식 Calculate fomula for cash back	캐시백 금액
FIXED_WITH_QUANTITY(수량별 정액할인)	정해진 금액을 구매한 상품 수량만큼 곱해서 캐시백을 적용합니다.	1000	null	Price : ￦5,000 Quantity : 2 Paid : ￦10,000	cash_back = value*Quantity	￦2,000
FIXED(정액할인)	고객이 구매한 상품의 수량과 상관없이 정해진 금액의 캐시백을 적용합니다. 여러개를 구매하여도 정해진 캐시백 금액만 적립됩니다.	1000	null	Price : ￦5,000 Quantity : 2 Paid : ￦10,000	cash_back = value	￦1,000

Path

POST

/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

Request Parameters

Path Segment Parameter

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

Body Parameter

Name	Required	Type	Description
ruleId	O	Number	Rule ID 캐시백 관련 계약완료 후 제공받은 룰 아이디를 입력
valueType	O	String	캐시백 유형 FIXED_WITH_QUANTITY(수량별 정액할인), FIXED(정액할인)
value	O	Number	적립액 최소값은 1
maxAmount		Number	최대적립금액 최소값은 0 FIXED 혹은 FIXED_WITH_QUANTITY 선택 시 파라미터 입력 불필요
vendorItemIds	O	Array	동일한 캐시백 룰을 적용하려는 옵션 ID 목록 최대 적립할 수 있는 옵션 ID 개수는 50개 필수값
startAt	O	String	시작일 yyyy-MM-ddTHH:mm:ss 현재 시간보다 최소 2시간 이후로 적용 가능 (현시간 오후 2시 일 경우, startAt은 오후 4시 이후로 설정 가능)
endAt	O	String	종료일 yyyy-MM-ddTHH:mm:ss

Request Example

{
  "ruleId": "3944",
  "valueType": "FIXED_WITH_QUANTITY",
  "value": "270",
  "maxAmount": "",
  "vendorItemIds": [
    "82650648946",
    "3000001897"
  ],
  "startAt": "2022-08-03T16:41:12",
  "endAt": "2099-12-31T23:59:59"
}

Response Message

Name

Type

Description

code

Number

Http request status code

예) 200, 400, 500

message

String

성공 혹은 실패에 따른 결과 메시지

200:	OK
206:	Partial successfully
400:	Bad request , will show corresponding bad request message
500:	Internal error

data

Object

캐시백 룰 성공 적용시 옵션목록으로 반환됨;실패시 실패원인 메세지 반환.

successVendorItemIds

Array

캐시백 룰 적용 성공한 옵션목록

failVendorItemIds

Array

캐시백 룰 적용 실패한 옵션목록과 해당 실패 메시지

Response Example

{
  "code": 206,
  "message": "PARTIAL_CONTENT",
  "data": {
    "successVendorItemIds": [
      "3000001886"
    ],
    "failVendorItemIds": [
      {
        "3000001905": "Invalid vendorItemId, vendorItemId doesn't exist or doesn't belong to corresponding vendorId"
      }
    ]
  }
}

Error Spec

HTTP 상태 코드(오류 유형)	오류 메시지	해결 방법
400 (요청변수확인)	Cashback value can't be null,and the min value is 1	적립액(value) 을 1이상 올바르게 입력했는지 확인합니다.
400 (요청변수확인)	RuleId can't be null, and must be numeric	RuleId 를 올바르게 입력했는지 확인합니다.
400 (요청변수확인)	Cashback type can't be empty, and the allowed values are FIXED,RATE and FIXED_WITH_QUANTITY.	캐시백유형(valueType) 값을 올바르게 입력했는지 확인합니다.
400 (요청변수확인)	vendorItemIds'list can't be empty, the min size is 1, and max size is 50	vendorItemIds 목록 값을 올바르게 입력했는지 확인합니다.
400 (요청변수확인)	The start or end time of Cashback rule can't be empty	시작일과 종료일을 올바르게 입력했는지 확인합니다.
500 (서버 오류)	INTERNAL_SERVER_ERROR	API 호출은 정상적으로 했지만, 시스템 오류로 인한 오류가 발생한 경우입니다. 정상적으로 캐시백이 적용됐는지 확인합니다.

URL API Name

UPDATE_PRODUCT_CASHBACK

[도서] 상품 캐시백 적용

요약

상세