coupang
POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/products/items/cashbackv1

[图书] 使用商品返现

# 01

简介

API 支持的买家用户地区:韩国 为 每 个产品单项 ID 使用 返 现规则 。 它 可以 应 用于使用了相同返 现规则 的 属性 , 并 且只能用于 审核通过 的 属性 。 * 返 现 功能 仅 适用于 图书产品 ,可 与酷澎销 售 负责人 在 签订 合同 并协商好 使用 政策 后使用。 每 种 返 现 的 业务逻辑请参 考下表: Value type 说明 value maxAmount Example 计算公式 返现金额 FIXED (定额折扣) 无 论顾客购买 的商品 数 量如何,都 会返还 固定金 额 。 即使 购买 多件商品,也只 会 累 积固定数 量的返 现 。

# 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

请求参数

Name 

 Required

Type 

Description 

vendorId 

O 

 String 

卖家ID 

酷澎分配给卖家的固有代码 e.g.) A00012345 

请求体

Name 

Required 

Type 

Description 

ruleId 

O 

 Number 

Rule ID  

输入返现相关合约签订后所提供的规则ID 

  

valueType 

O 

 String 

现类型 

FIXED(定折扣), FIXED_WITH_QUANTITY(按量定折扣 

value 

O 

 Number 

累计值 

最少1 

maxAmount 

  

 Number 

最大返现值 

最少0FIXEDFIXED_WITH_QUANTITY无需该参数

vendorItemIds 

O 

 Array 

要使用相同返现规则属性ID 列表 

可返性ID最多50 

必须值 

startAt 

O 

 String 

开始时间 

yyyy-MM-ddTHH:mm:ss  

至少比时间晚2 时才可使用(如果时间是下午 2 点,可在下午4 点之后 startAt 

endAt 

O 

 String 

结束时间 

yyyy-MM-ddTHH:mm:ss 

请求体示例

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

返回消息

Name 

Type 

Description 

code 

Number 

Http 请状态代码 

EX) 200, 400, 500 

message 

String 

成功或失败时信息 

200: 

OK 

206: 

部分成功 

400: 

错误请求,将显示相错误请求消息 

500: 

错误 

 

data 

Object 

现规则应用成功返回属性列表;如果失,返回失原因。 

  

successVendorItemIds 

Array 

用返现规则成功的属性列表 

  

failVendorItemIds 

Array 

现规则应用失败的属性列表和相的失败原因 

返回消息示例

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

错误信息

HTTP status code (Error type) 

Error message 

Solution 

400 (Check parameter requested) 

返现值不可为空,最小值为1 

查看是否正确输入了1及大于1的返现值(value) 

400 (Check parameter requested) 

RuleId不可为空,必须为数字  

 查看RuleId是否输入正确。 

400 (Check parameter requested) 

现类型不能空,可用值为FIXEDRATEFIXED_WITH_QUANTITY 

 查看返现类型(valueType)值是否输入正确。 

400 (Check parameter requested) 

vendorItemId列表不可为空, 最小数为1,最大为50。 

查看vendorItemId列表值是否输入正确。 

400 (Check parameter requested) 

返现规则的开始或结束时间不可为空。 

查看是否正确入了始日期和束日期。 

500 (Server Error) 

INTERNAL_SERVER_ERROR 

API用成功,但系统内部发错误 查看返现是否正常应用 

接口名称

UPDATE_PRODUCT_CASHBACK