coupang
POST/v2/providers/fms/apis/api/v2/vendors/{vendorId}/coupon2609170000

[立减优惠券] 创建

# 01

简介

[立减优惠券] 创建

# 02

详细内容

API支持的买家用户地区:韩国

该API用于创建基于合同ID(contractid)的优惠券。因以异步方式,仅执行处理请求,

可使用响应的“requestedId” 值,通过确认请求状态API来查看实际API 执行结果值。

请在添加产品到立减优惠券的时候谨慎选择产品列表,因为此立减优惠券创建之后卖家就无法对优惠券的产品列表进行删除操作。如果您确实需要删除其中的一些产品,请暂停旧的优惠券,创建新的立减优惠券,并添加新的产品列表。

路径

POST/v2/providers/fms/apis/api/v2/vendors/{vendorId}/coupon

示例端点

https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00012345/coupon
# 03

Path 参数

NameTypeDescription
vendorId*string
卖家ID

酷澎分配给卖家的固有代码 Ex) A00012345
# 04

请求体参数

请求参数

请求体参数

NameTypeDescription
vendorId*string
卖家ID

酷澎分配给卖家的固有代码 Ex) A00012345
contractId*string
卖家合同ID
name*string
促销展名 (最多45个字)
maxDiscountPrice*string
最多折扣金额

最少10韩元
discount*string
折扣率
startAt*string
有效期开始时间

有效期开始日期可设置为次日00:00

例:如果优惠券在8月4日15:00创建,则8月5日00:00开始可以使用优惠券
endAt*string
有效期结束时间
type*string
折扣方式

RATE (固定折扣率), FIXED_WITH_QUANTITY (按数量定额折扣), PRICE (定额折扣)
wowExclusivestring
发放对象

可使用优惠券的对象
false 所有顾客 (默认)
true 火箭Wow会员
一般的满减优惠券,请创建为"false"。

true 是以火箭Wow会员为对象,用于goldbox等促销展中所选商品的值,应用于商品时需要提前申请批准。
codestring
服务器响应代码
messagestring
服务器响应信息
errorMessagestring
除HTTP Status 200以外,剩下Status 中包含服务器详细失败原因信息
datastring
执行成功与否的数据
success
data.success
string
成功与否

true or false
content
data.content
string
可查看处理状态的请求ID数据
requestedId
data.content.requestedId
string
查看处理状态的请求ID

ex) 1542675975663862164
success
data.content.success
string
成功与否

true or false
Pagination
data.Pagination
string
无分页
400 (check request parameter)string
查看是否输入了正确的折扣率的值。
请求示例application/json
{
  "contractId": "10",
  "name": "newCoupon 20180328",
  "maxDiscountPrice": "1000",
  "discount": "10",
  "startAt": "2017-12-08 00:00:00",
  "endAt": "2017-12-09 00:00:00",
  "type": "PRICE",
  "wowExclusive": "false"
}
# 05

响应体

响应消息

NameTypeDescription
codeinteger
服务器响应代码
messagestring
服务器响应信息
httpStatusinteger
HTTP
httpStatusMessagestring
HTTP 状态信息 (与服务器响应信息的值相同)
errorMessagestring
除HTTP Status 200以外,剩下Status 中包含服务器详细失败原因信息
dataobject
执行成功与否的数据
success
data.success
boolean
成功与否

true or false
content
data.content
object
可查看处理状态的请求ID数据
requestedId
data.content.requestedId
string
查看处理状态的请求ID

ex) 1542675975663862164
success
data.content.success
boolean
成功与否

true or false
Pagination
data.Pagination
string
无分页

Response Example

{
  "code": 200,
  "message": "OK",
  "httpStatus": 200,
  "httpStatusMessage": "OK",
  "errorMessage": "",
  "data": {
    "success": true,
    "content": {
      "requestedId": "123543582159745830895",
      "success": true
    },
    "pagination": null
  }
}
# 06

错误码

HTTP代码消息
400HTTP_400Bad Request

错误说明

HTTP类型错误消息解决方案
400400 (check request parameter)

优惠券必须在合同有效期内(合同有效期:2017-03-01 00:00:00 ~ 2017-12-31 23:59:59)(优惠券有效期:2016-12-05 00:00 :00~2017-09-05 00:00:00)

查看优惠券的有效期开始日期和结束日期是否包含在合同有效期内。

400400 (check request parameter)

无法解析“2017-13-05 00:00:00”:monthOfYear 的value13 必须在 [1,12] 范围内

查看是否正确输入了有效期的开始或结束日期值。

400400 (check request parameter)

无法解析“2017-08-32 00:00:00”:dayOfMonth的value 32 必须在 [1,31] 范围内

查看是否正确输入了有效期的开始或结束日期值。

400400 (check request parameter)

请查看startAt 格式。 yyyy-MM-dd HH:mm:ss

查看是否输入了正确的有效期开始时间格式。

400400 (check request parameter)

请查看endAt 格式。 yyyy-MM-dd HH:mm:ss

查看是否输入了正确的有效期结束时间格式。.

400400 (check request parameter)

Can only input positive number for discount. (discount rate: 1~100; discount amount: 1 or larger)

discount只能输入正数。(固定折扣率为1~100,定额为1以上)

查看是否输入了正确的折扣率的值。