POST
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/products/items/cashback2609170000[图书] 使用商品返现
# 01
简介
[图书] 使用商品返现
# 02
详细内容
API支持的买家用户地区：韩国
为每个产品单项ID 使用返现规则。
它可以应用于使用了相同返现规则的属性，并且只能用于审核通过的属性。
- 返现功能仅适用于图书产品，可与酷澎销售负责人在签订合同并协商好使用政策后使用。
每种返现的业务逻辑请参考下表：
| Value type | 说明 | value | maxAmount | Example | 计算公式 | 返现金额 |
|---|---|---|---|---|---|---|
| FIXED（定额折扣） | 无论顾客购买的商品数量如何，都会返还固定金额。 即使购买多件商品，也只会累积固定数量的返现。 | 1000 | null | Price : ￦5,000 Quantity : 2 Paid : ￦10,000 | cash_back = value | ￦1,000 |
| FIXED_WITH_QUANTITY（按照数量定额） | 返现金额为固定金额乘以购买的商品数量。 | 1000 | null | Price : ￦5,000 Quantity : 2 Paid : ￦10,000 | cash_back = value*Quantity | ￦2,000 |
路径
POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/products/items/cashback
示例端点
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/products/items/cashback# 03
Path 参数
| Name | Type | Description |
|---|---|---|
| vendorId* | string | 卖家ID 酷澎分配给卖家的固有代码 e.g.) A00012345 |
# 04
请求体参数
请求参数
请求体参数
| Name | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| vendorId* | string | 卖家ID 酷澎分配给卖家的固有代码 e.g.) A00012345 | ||||||||
| ruleId* | string | Rule ID 输入返现相关合约签订后所提供的规则ID | ||||||||
| valueType* | string | 返现类型 FIXED（定额折扣）, FIXED_WITH_QUANTITY（按数量定额折扣 | ||||||||
| value* | string | 累计值 最少值1 | ||||||||
| maxAmount | string | 最大返现值 最少值0；FIXED或FIXED_WITH_QUANTITY无需该参数 | ||||||||
| vendorItemIds* | object[] | 要使用相同返现规则的属性ID 列表 可返现的属性ID最多为50个。 必须值 | ||||||||
| startAt* | string | 开始时间 yyyy-MM-ddTHH:mm:ss 至少比当前时间晚2 小时才可使用（如果当前时间是下午 2 点，则可在下午4 点之后设置 startAt） | ||||||||
| endAt* | string | 结束时间 yyyy-MM-ddTHH:mm:ss | ||||||||
| code | string | Http 申请
| ||||||||
| message | string | 成功或失败时相应信息会出现
| ||||||||
| data | string | 当返现规则应用成功时，返回属性列表；如果失败，返回失败原因。
| ||||||||
| successVendorItemIds data.successVendorItemIds | string | 应用返现规则成功的属性列表
| ||||||||
| failVendorItemIds data.failVendorItemIds | string | 返现规则应用失败的属性列表和相应的失败原因
| ||||||||
| 400 (Check parameter requested) | string | 查看是否正确输入了开始日期和结束日期。
| ||||||||
| 500 (Server Error) | string | API调用成功，但系统内部发生错误。 查看返现是否正常应用。
|
请求示例application/json
{
"ruleId": "3944",
"valueType": "FIXED_WITH_QUANTITY",
"value": "270",
"maxAmount": "",
"vendorItemIds": [
"82650648946",
"3000001897"
],
"startAt": "2022-08-03T16:41:12",
"endAt": "2099-12-31T23:59:59"
}# 05
响应体
响应消息
| Name | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| code | integer | Http 申请
| ||||||||
| message | string | 成功或失败时相应信息会出现
| ||||||||
| data | object | 当返现规则应用成功时，返回属性列表；如果失败，返回失败原因。
| ||||||||
| successVendorItemIds data.successVendorItemIds | object[] | 应用返现规则成功的属性列表
| ||||||||
| failVendorItemIds data.failVendorItemIds | object[] | 返现规则应用失败的属性列表和相应的失败原因
|
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"
}
]
}
}# 06
错误码
| HTTP | 代码 | 消息 |
|---|---|---|
| 400 | HTTP_400 | Bad Request |
错误说明
| HTTP | 类型 | 错误消息 | 解决方案 |
|---|---|---|---|
| 400 | 400 (Check parameter requested) | 返现值不可为空，最小值为1 | 查看是否正确输入了1及大于1的返现值（value） |
| 400 | 400 (Check parameter requested) | RuleId不可为空，必须为数字 | 查看RuleId是否输入正确。 |
| 400 | 400 (Check parameter requested) | 返现类型不能为空，可用值为FIXED、RATE和FIXED_WITH_QUANTITY。 | 查看返现类型（valueType）值是否输入正确。 |
| 400 | 400 (Check parameter requested) | vendorItemId列表不可为空, 最小数为1，最大为50。 | 查看vendorItemId列表值是否输入正确。 |
| 400 | 400 (Check parameter requested) | 返现规则的开始或结束时间不可为空。 | 查看是否正确输入了开始日期和结束日期。 |
| 500 | 500 (Server Error) | INTERNAL_SERVER_ERROR | API调用成功，但系统内部发生错误。 查看返现是否正常应用。 |